Update Travis & Codecov support, update README.md

.release

@@ -0,0 +1,4 @@
+#!/bin/sh
+# This file is executed by the `release` script from
+# https://github.com/gap-system/ReleaseTools
+rm -rf .travis.yml .codecov.yml scripts

.travis.yml

@@ -8,18 +8,10 @@ addons:
   apt_packages:
     - libgmp-dev
     - libreadline-dev
-    - libgmp-dev:i386
-    - libreadline-dev:i386
-    - gcc-multilib
-    - g++-multilib
 
 matrix:
   include:
-    - env: CFLAGS="-O2" CC=clang CXX=clang++
-      compiler: clang
     - env: CFLAGS="-O2"
-      compiler: gcc
-    - env: ABI=32
 
 branches:
   only:

README.md

@@ -1,8 +1,11 @@
 [![Build Status](https://travis-ci.org/gap-packages/numericalsgps.svg?branch=master)](https://travis-ci.org/gap-packages/numericalsgps)
 [![Code Coverage](https://codecov.io/github/gap-packages/numericalsgps/coverage.svg?branch=master&token=)](https://codecov.io/gh/gap-packages/numericalsgps)
 
-The GAP 4 package `NumericalSgps` to compute with Numerical Semigroups
-======================================================================
+NumericalSgps
+=============
+
+`NumericalSgps` is a GAP package for computing with Numerical Semigroups.
+
 
 Introduction
 ------------
@@ -16,7 +19,7 @@ The features of this package include
 - perform several operations on numerical semigroups and ideals, namely: intersection, quotient by an integer, decompose into irreducible semigroups, add a special gap, ...;
 -computing and testing membership to relevant families of numerical semigroups.
 
-There is a manual in the sub-directory 'doc' written using the GAP package
+There is a manual in the sub-directory `doc` written using the GAP package
 gapdoc which describes the available functions in detail. The pdf, html
 versions of the manual are also available there.
 

scripts/build_gap.sh

@@ -1,4 +1,11 @@
 #!/usr/bin/env bash
+#
+# DO NOT EDIT THIS FILE!
+#
+# If you have any questions about this script, or think it is not general
+# enough to cover your use case (i.e., you feel that you need to modify it
+# anyway), please contact Max Horn <max.horn@math.uni-giessen.de>.
+#
 set -ex
 
 # clone GAP into a subdirectory
@@ -23,8 +30,12 @@ make -j4 V=1
 # connection is refused, to work around intermittent failures
 make bootstrap-pkg-full WGET="wget -N --no-check-certificate --tries=5 --waitretry=5 --retry-connrefused"
 
-# build some packages (default is to build 'io' and 'profiling',
-# in order to generate coverage results)
+# build some packages; default is to build 'io' and 'profiling', in order to
+# generate coverage results. If you need to build additional packages (or for
+# some reason need to build a custom version of io or profiling), please set
+# the GAP_PKGS_TO_BUILD environment variable (e.g. in your .travis.yml), or
+# directly call BuildPackages.sh from .travis.yml. For an example of the
+# former, take a look at the cvec package.
 cd pkg
 for pkg in ${GAP_PKGS_TO_BUILD-io profiling}; do
     ../bin/BuildPackages.sh --strict $pkg*

scripts/build_pkg.sh

@@ -1,16 +1,24 @@
 #!/usr/bin/env bash
+#
+# DO NOT EDIT THIS FILE!
+#
+# If you have any questions about this script, or think it is not general
+# enough to cover your use case (i.e., you feel that you need to modify it
+# anyway), please contact Max Horn <max.horn@math.uni-giessen.de>.
+#
 set -ex
 
 # ensure coverage is turned on
 export CFLAGS="$CFLAGS -fprofile-arcs -ftest-coverage"
 export LDFLAGS="$LDFLAGS -fprofile-arcs"
 
+# adjust build flags for 32bit builds
 if [[ $ABI = 32 ]]; then
     export CFLAGS="$CFLAGS -m32"
     export LDFLAGS="$LDFLAGS -m32"
 fi
 
-# build this package
+# build this package, if necessary
 if [[ -x autogen.sh ]]; then
     ./autogen.sh
     ./configure --with-gaproot=$GAPROOT
@@ -20,5 +28,7 @@ elif [[ -x configure ]]; then
     make -j4
 fi
 
-# trick to allow the package directory to be used as a GAP root dir
-ln -s . pkg
+# set up a custom GAP root containing only this package, so that
+# we can force GAP to load the correct version of this package
+mkdir -p gaproot/pkg/
+ln -s $PWD gaproot/pkg/

scripts/gather-coverage.sh

@@ -1,12 +1,23 @@
 #!/usr/bin/env bash
+#
+# DO NOT EDIT THIS FILE!
+#
+# If you need to collect additional coverage data, please do so
+# from your .travis.yml or a custom script.
+#
+# If you have any questions about this script, or think it is not general
+# enough to cover your use case (i.e., you feel that you need to modify it
+# anyway), please contact Max Horn <max.horn@math.uni-giessen.de>.
+#
 set -ex
 
 # If we don't care about code coverage, do nothing
 if [[ -n $NO_COVERAGE ]]; then
     exit 0
 fi
 
-GAP="$GAPROOT/bin/gap.sh -l $PWD; --quitonbreak -q"
+# start GAP with custom GAP root, to ensure correct package version is loaded
+GAP="$GAPROOT/bin/gap.sh -l $PWD/gaproot; --quitonbreak -q"
 
 # generate library coverage reports
 $GAP -a 500M -m 500M -q <<GAPInput

scripts/run_tests.sh

@@ -1,9 +1,21 @@
 #!/usr/bin/env bash
+#
+# DO NOT EDIT THIS FILE!
+#
+# If you need to run additional setup steps before the package tests,
+# edit the run script in .travis.yml instead
+#
+# If you have any questions about this script, or think it is not general
+# enough to cover your use case (i.e., you feel that you need to modify it
+# anyway), please contact Max Horn <max.horn@math.uni-giessen.de>.
+#
 set -ex
 
-GAP="$GAPROOT/bin/gap.sh -l $PWD; --quitonbreak"
+# start GAP with custom GAP root, to ensure correct package version is loaded
+GAP="$GAPROOT/bin/gap.sh -l $PWD/gaproot; --quitonbreak"
 
-# unless explicitly turned off, we collect coverage data
+# Unless explicitly turned off by setting the NO_COVERAGE environment variable,
+# we collect coverage data
 if [[ -z $NO_COVERAGE ]]; then
     mkdir $COVDIR
     GAP="$GAP --cover $COVDIR/test.coverage"