Skip to content

Commit 2789e82

Browse files
authored
Update many broken links, update outdated docs etc. (#6153)
Also, - update list of contributors in COPYRIGHT file - update GPL 2.0 text to current version (with a URL instead of a postal address) - clarify copyright statement in the manual - remove invalid or misleading licensing conditions beyond GPL - add the names of Fedora packages needed by several of our packages (complementing the Debian and Homebrew names already listed) - replace outdated information about the GAP website in the dev manual - remove empty chapter about git in the dev manual
1 parent e898030 commit 2789e82

File tree

18 files changed

+80
-581
lines changed

18 files changed

+80
-581
lines changed

.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Max Neunhöffer <[email protected]>
3737
Michael Young <[email protected]>
3838
Paula Hähndel <[email protected]>
3939
Russ Woodroofe <[email protected]>
40+
Sam Tertooy <[email protected]>
4041
4142
Sergio Siccha <[email protected]>
4243

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ possible.
88
## Packages versus contributions to the "core" system
99

1010
One way of contributing to GAP is to write a
11-
[GAP package](https://www.gap-system.org/Packages/packages.html) and send it
11+
[GAP package](https://www.gap-system.org/packages/authors/) and send it
1212
to us to consider for redistribution with GAP. This is appropriate if your
1313
contribution adds a body of functionality for some area of mathematics (or
1414
some coherent batch of system functionality). A package is also appropriate

COPYRIGHT

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,21 @@ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
1111
License for more details.
1212

1313
You should have received a copy of the GNU General Public License
14-
along with GAP; if not, write to the Free Software Foundation, Inc.,
15-
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
14+
along with GAP; if not, see <https://www.gnu.org/licenses/>.
1615

1716

18-
Copyright (C) 1988-2024 by its authors, which include:
17+
Copyright (C) 1988-2025 by its authors, which include:
1918

2019
* Ákos Seress
2120
* Alex Wegner
2221
* Alexander Hulpke
2322
* Alice Niemeyer
23+
* Anakin Dey
2424
* Andreas Distler
2525
* Andrew Solomon
2626
* Anna Sucker
2727
* Ansgar Kaup
28+
* Arhan Chaudhary
2829
* Arne Storjohann
2930
* Bernhard Reinke
3031
* Bettina Eick
@@ -47,7 +48,7 @@ Copyright (C) 1988-2024 by its authors, which include:
4748
* Dmitrii Pasechnik
4849
* Dominik Bernhardt
4950
* Emma Ahrens
50-
* Erik M. Bray
51+
* E. Madison Bray
5152
* Erzsébet Horváth
5253
* Etaoin Shrdlu
5354
* Fabian Zickgraf
@@ -69,9 +70,11 @@ Copyright (C) 1988-2024 by its authors, which include:
6970
* Isabel M. Araújo
7071
* Isuru Fernando
7172
* Jack Schmidt
73+
* Jake Faulkner
7274
* James Mitchell
7375
* James Williams
7476
* Jan de Muijnck-Hughes
77+
* Jan Engelhardt
7578
* Jendrik Brachter
7679
* Jens Brandt
7780
* Jens Hollmann
@@ -80,11 +83,13 @@ Copyright (C) 1988-2024 by its authors, which include:
8083
* Jerry James
8184
* Jesse Lansdown
8285
* Joachim Neubüser
86+
* Joe Edwards
8387
* Johannes Meier
8488
* John McDermott
8589
* Jürgen Mnich
8690
* Jürgen Müller
8791
* Juergen Wisliceny
92+
* Lars Göttgens
8893
* Laurent Bartholdi
8994
* Lucas Jones
9095
* Lucas Wollenhaupt
@@ -109,13 +114,16 @@ Copyright (C) 1988-2024 by its authors, which include:
109114
* Paula Hähndel
110115
* Ramón Esteban Romero
111116
* Reimer Behrends
117+
* Reinis Cirpons
112118
* Rob Wainwright
113119
* Robert Arthur
114120
* Robert F. Morse
115121
* Russ Woodroofe
116122
* Ruth Hoffmann
123+
* Sam Tertooy
117124
* Sandeep Murthy
118125
* Sarah Rees
126+
* Scott Brenner
119127
* Scott Murray
120128
* Sebastian Gutsche
121129
* Sergio Siccha
@@ -126,6 +134,7 @@ Copyright (C) 1988-2024 by its authors, which include:
126134
* Thomas Bischops
127135
* Thomas Breuer
128136
* Thomas Merkwitz
137+
* Torben Wiedemann
129138
* Udo Polis
130139
* Ute Schiffer
131140
* VInay Wagh

INSTALL.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@ for Windows.
2222
Alternative installation methods which aim to simplify the installation
2323
mostly by offering precompiled binaries are:
2424

25+
* Several Linux distributions such as Debian/Ubuntu or Fedora have
26+
packaged GAP itself; see e.g. <https://repology.org/project/gap/versions>
2527
* GAP installer for Homebrew (package manager for macOS)
2628
* Docker image for GAP and most of the packages
2729
* the rsync-based binary distribution for Linux
2830

2931
Note, however, that these are updated independently and may not yet provide
30-
the latest GAP release. Further details are available on the GAP website
31-
here: <https://www.gap-system.org/Download/alternatives.html>.
32+
the latest GAP release.
3233

3334

3435
1 Installation Overview
@@ -49,9 +50,9 @@ section "Installing required dependencies" in the file `README.md`.
4950
To get maximum benefit from GAP and from various packages, we recommend
5051
to install a number of other free software libraries (and their associated
5152
development tools) although they are not required for basic operation.
52-
See <https://www.gap-system.org/Download/tools.html> for more details.
53+
See Section "Compilation" below for more details.
5354

54-
The installation consists of five easy steps:
55+
The installation consists of five steps:
5556

5657
1. Get the archive suitable for your system
5758
2. Unpack the archive in the directory where you wish to install GAP
@@ -76,7 +77,7 @@ common problems with the installation.
7677
=====================
7778

7879
You can get archives for the GAP distribution from the GAP website at
79-
<https://www.gap-system.org/Releases/>. If you use Unix (including macOS),
80+
<https://www.gap-system.org/install/>. If you use Unix (including macOS),
8081
you need to download the GAP source distribution, that is, a file named
8182

8283
gap-4.X.Y.tar.bz2
@@ -147,7 +148,7 @@ On Ubuntu or Debian, you can install these with the following command:
147148

148149
On Fedora:
149150

150-
sudo dnf install gcc gcc-c++ make autoconf gmp gmp-devel readline readline-devel zlib zlib-devel
151+
sudo dnf install gcc gcc-c++ make autoconf gmp-devel readline-devel zlib-devel
151152

152153
On Alpine:
153154

@@ -164,27 +165,35 @@ prerequisites. Here is an incomplete list of GAP packages and their requirements
164165

165166
- 4ti2Interface
166167
- Debian/Ubuntu: 4ti2
168+
- Fedora: 4ti2-devel
167169
- Homebrew: (not currently available)
168170
- alnuth
169171
- Debian/Ubuntu: pari-gp
172+
- Fedora: pari-gp
170173
- Homebrew: pari
171174
- browse
172175
- Debian/Ubuntu: libncurses-dev
176+
- Fedora: ncurses-devel
173177
- Homebrew: ncurses
174178
- CddInterface
175179
- Debian/Ubuntu: libcdd-dev
180+
- Fedora: cddlib-devel
176181
- Homebrew: cddlib
177182
- curlInterface
178183
- Debian/Ubuntu: libcurl4-openssl-dev
184+
- Fedora: curl-devel
179185
- Homebrew: curl
180186
- float
181187
- Debian/Ubuntu: libfplll-dev libmpc-dev libmpfi-dev libmpfr-dev
188+
- Fedora: fplll libmpc-devel mpfi-devel mpfr-devel
182189
- Homebrew: fplll libmpc mpfi mpfr
183190
- singular
184191
- Debian/Ubuntu: singular
192+
- Fedora: Singular
185193
- Homebrew: singular
186194
- ZeroMQInterface
187195
- Debian/Ubuntu: libzmq3-dev
196+
- Fedora: zeromq-devel
188197
- Homebrew: zmq
189198

190199

@@ -411,7 +420,7 @@ found at <https://gap-packages.github.io/>.
411420
Congratulations, your installation is finished.
412421

413422
Once the installation is complete, you may wish to subscribe to the
414-
[GAP forum mailing list](https://www.gap-system.org/Contacts/Forum/forum.html),
423+
[GAP forum mailing list](https://www.gap-system.org/forum/),
415424
which provides help with user questions of a general nature. You can also
416425
chat with us on [Slack](https://gap-system.org/slack). Bug reports and other
417426
problems you have while installing and/or using GAP should be reported via
@@ -465,7 +474,7 @@ the help system which provides useful search features.
465474

466475
This section lists a few common problems when installing or running GAP and
467476
their remedies. Also see the FAQ list on the GAP web pages at
468-
<https://www.gap-system.org/Faq/faq.html>.
477+
<https://www.gap-system.org/faq/>.
469478

470479
### GAP starts with a warning `hmm, I cannot find lib/init.g`
471480

LICENSE

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Version 2, June 1991
33

44
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5-
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5+
<https://fsf.org/>
66
Everyone is permitted to copy and distribute verbatim copies
77
of this license document, but changing it is not allowed.
88

@@ -304,8 +304,7 @@ the "copyright" line and a pointer to where the full notice is found.
304304
GNU General Public License for more details.
305305

306306
You should have received a copy of the GNU General Public License along
307-
with this program; if not, write to the Free Software Foundation, Inc.,
308-
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
307+
with this program; if not, see <https://www.gnu.org/licenses/>.
309308

310309
Also add information on how to contact you by electronic and paper mail.
311310

@@ -329,8 +328,8 @@ necessary. Here is a sample; alter the names:
329328
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330329
`Gnomovision' (which makes passes at compilers) written by James Hacker.
331330

332-
<signature of Ty Coon>, 1 April 1989
333-
Ty Coon, President of Vice
331+
<signature of Moe Ghoul>, 1 April 1989
332+
Moe Ghoul, President of Vice
334333

335334
This General Public License does not permit incorporating your program into
336335
proprietary programs. If your program is a subroutine library, you may

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
GAP is a system for computational discrete algebra, with particular emphasis
1111
on computational group theory. GAP provides a programming language, a library
1212
of thousands of functions implementing algebraic algorithms written in the GAP
13-
language as well as large data libraries of algebraic objects. For a more
14-
detailed overview, see
15-
<https://www.gap-system.org/Overview/overview.html>.
13+
language as well as large data libraries of algebraic objects. For some more
14+
information, see
15+
<https://www.gap-system.org/about/>.
1616
For a description of the mathematical capabilities, see
17-
<https://www.gap-system.org/Overview/Capabilities/capabilities.html>.
17+
<https://www.gap-system.org/capabilities/>.
1818

1919
GAP is used in research and teaching for studying groups and their
2020
representations, rings, vector spaces, algebras, combinatorial structures, and
@@ -26,9 +26,8 @@ easily modify or extend it for your special use.
2626

2727
## Download a stable release version
2828

29-
The latest stable release of the GAP system, including all currently
30-
redistributed GAP packages, can be obtained from
31-
<https://www.gap-system.org/Releases/index.html>.
29+
The latest stable release of the GAP system can be obtained from
30+
<https://www.gap-system.org/install/>.
3231
Afterwards, follow the instructions in the file `INSTALL.md` in the GAP root
3332
directory.
3433

@@ -69,7 +68,7 @@ On Ubuntu or Debian, you can install these with the following command:
6968

7069
On Fedora:
7170

72-
sudo dnf install gcc gcc-c++ make autoconf gmp gmp-devel readline readline-devel zlib zlib-devel
71+
sudo dnf install gcc gcc-c++ make autoconf gmp-devel readline-devel zlib-devel
7372

7473
On Alpine:
7574

@@ -134,18 +133,13 @@ please read the [contributor guidelines](CONTRIBUTING.md). Additional informatio
134133

135134
To keep up to date on GAP news (discussion of problems, release announcements,
136135
bug fixes), you can subscribe to the
137-
[GAP forum](https://www.gap-system.org/Contacts/Forum/forum.html) and
136+
[GAP forum](https://www.gap-system.org/forum/) and
138137
[GAP development](https://lists.uni-kl.de/gap/info/gap) mailing lists,
139-
notifications on GitHub, and chat with us on [Slack](https://gap-system.org/slack).
138+
notifications on GitHub, or chat with us on [Slack](https://gap-system.org/slack).
140139

141-
If you have any questions about working with GAP, you can ask them on
142-
[GAP forum](https://www.gap-system.org/Contacts/Forum/forum.html) (requires subscription)
143-
or [GAP support](https://www.gap-system.org/Contacts/People/supportgroup.html) mailing lists.
144-
145-
Please tell us about your use of GAP in research or teaching. We maintain a
146-
[bibliography of publications citing GAP](https://www.gap-system.org/Doc/Bib/bib.html).
147-
Please [help us](https://www.gap-system.org/Contacts/publicationfeedback.html)
148-
keeping it up to date.
140+
If you have any questions about working with GAP, you can ask them on the
141+
[GAP forum](https://www.gap-system.org/forum/) mailing list (requires subscription)
142+
or [use one of our various support channels](https://www.gap-system.org/issues).
149143

150144

151145
# License

doc/dev/git.xml

Lines changed: 0 additions & 12 deletions
This file was deleted.

doc/dev/main.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ there is a concept of <E>modules</E> where parts of the
4747
<#Include SYSTEM "lib.xml">
4848
<#Include SYSTEM "documentation.xml">
4949
<#Include SYSTEM "testing.xml">
50-
<#Include SYSTEM "git.xml">
5150
<#Include SYSTEM "pkgdist.xml">
5251
<#Include SYSTEM "website.xml">
5352
<#Include SYSTEM "newcode.xml">

doc/dev/testing.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ Moreover, it is recommended to group tests that require packages to be
4242
performed after all other tests are completed.
4343

4444
The directory <F>tst/testinstall</F> contains a subset of tests which are
45-
recommended after installing &GAP;,
46-
see <URL>https://www.gap-system.org/Download/INSTALL</URL>.
45+
recommended after installing &GAP;.
4746
The idea is that the examples in these <C>.tst</C> files are typical
4847
&GAP; computations,
4948
and that running these tests requires only a few minutes.

0 commit comments

Comments
 (0)