Skip to content

Commit

Permalink
Sort the content of dev and etc directories
Browse files Browse the repository at this point in the history
The idea is that `etc` is shipped in GAP releases and contains extras
for users, while `dev` is not shipped and only for people interacting
with the GAP git repository. Hence move CI specific helper scripts as
well as `bisect.sh` from `etc` to `dev`.

Conversely, move some ctags related files from `dev` to `etc`, as those are
needed to let `make tags` function correctly.

Move `download.sh` from `etc` to `cnf` as it is used by the build system,
not users.

Finally, add `etc/README.md` explaining some of the files there.
  • Loading branch information
fingolfin committed Feb 18, 2021
1 parent e15af08 commit 7a57e8c
Show file tree
Hide file tree
Showing 16 changed files with 36 additions and 12 deletions.
8 changes: 4 additions & 4 deletions .appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ build_script:
- SET "PATH=%CYG_ROOT%\bin;%PATH%"
- python -m pip install gcovr==4.2 # for coverage reporting later on
- bash -lc "gcc --version"
- bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./etc/ci-prepare.sh"
- bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./dev/ci-prepare.sh"

test_script:
- bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./etc/ci.sh"
- bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./dev/ci.sh"

on_success:
# make sure to use AppVeyor's Python (not Cygwin's) in the next step
- bash -lc "export PATH="/cygdrive/c/Python27:/cygdrive/c/Python27/Scripts:$PATH" ; cd $APPVEYOR_BUILD_FOLDER && ./etc/ci-gather-coverage.sh"
- bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./etc/ci-run-codecov.sh"
- bash -lc "export PATH="/cygdrive/c/Python27:/cygdrive/c/Python27/Scripts:$PATH" ; cd $APPVEYOR_BUILD_FOLDER && ./dev/ci-gather-coverage.sh"
- bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./dev/ci-run-codecov.sh"
2 changes: 1 addition & 1 deletion .ctags
8 changes: 4 additions & 4 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -185,13 +185,13 @@ jobs:
python -m pip install gcovr
- name: "Compile GAP and download packages"
run: ${{ matrix.extra }} bash etc/ci-prepare.sh
run: ${{ matrix.extra }} bash dev/ci-prepare.sh
- name: "Run tests"
run: ${{ matrix.extra }} bash etc/ci.sh
run: ${{ matrix.extra }} bash dev/ci.sh
- name: "Gather coverage"
run: ${{ matrix.extra }} bash etc/ci-gather-coverage.sh
run: ${{ matrix.extra }} bash dev/ci-gather-coverage.sh
- name: "Upload coverage data to codecov"
run: ${{ matrix.extra }} bash etc/ci-run-codecov.sh
run: ${{ matrix.extra }} bash dev/ci-run-codecov.sh
# - uses: codecov/codecov-action@v1

# TODO: fix coveralls integration
Expand Down
2 changes: 1 addition & 1 deletion Makefile.rules
Original file line number Diff line number Diff line change
Expand Up @@ -1136,7 +1136,7 @@ PKG_BRANCH = master
PKG_BOOTSTRAP_URL = https://files.gap-system.org/gap4pkgs/
PKG_MINIMAL = packages-required-$(PKG_BRANCH).tar.gz
PKG_FULL = packages-$(PKG_BRANCH).tar.gz
DOWNLOAD = $(abs_srcdir)/etc/download.sh
DOWNLOAD = $(abs_srcdir)/cnf/download.sh

bootstrap-pkg-minimal:
@if test -e pkg; then \
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion etc/ci-gather-coverage.sh → dev/ci-gather-coverage.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ then
# generate kernel coverage reports by running gcov
python -m gcovr -r . -o c-coveralls.json --json --exclude-directories pkg/ --exclude-directories extern/ -e pkg/ -e extern/

python etc/ci-coveralls-merge.py
python dev/ci-coveralls-merge.py
fi

# upload to coveralls.io
Expand Down
2 changes: 1 addition & 1 deletion etc/ci-prepare.sh → dev/ci-prepare.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ time "$SRCDIR/configure" --enable-Werror $CONFIGFLAGS
time make V=1 -j4

# Use alternative downloader which retries on failure and uses the Travis cache
DOWNLOAD="$SRCDIR/etc/ci-download.sh"
DOWNLOAD="$SRCDIR/dev/ci-download.sh"
if [[ $(uname) == Darwin ]]
then
# Travis OSX builders seem to have very small download bandwidth,
Expand Down
File renamed without changes.
0 etc/ci.sh → dev/ci.sh
100644 → 100755
File renamed without changes.
File renamed without changes.
24 changes: 24 additions & 0 deletions etc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# The GAP etc/ directory

Here is an overview of the files in this directory. Most of them
contain comments with a more detailed description of what they do.

## Files for GAP developers

The following are tools for people working on the GAP code base itself

- `ffgen.c`: used by the GAP build system
- `tags.sh`: used by the `make tags` build target

## Files for GAP package authors

- `Makefile.gappkg`: build rules intended for use by GAP packages with a kernel extension
- `convert.pl`: script to convert old style gapmacro-based GAP manual TeX files to HTML

## Files for all GAP users

- `log2html.g`: Utility to convert GAP log files to XHTML 1.0 Strict.
- `gaplog.css`: used by `log2html.g`
- `emacs`: used to contain GAP integration for emacs
- `vim`: GAP integration for vim
- `xrmtcmd.c`: for use by the GAP help system on X-Window, to control `xdvi`
File renamed without changes.
File renamed without changes.

0 comments on commit 7a57e8c

Please sign in to comment.