Skip to content

Commit 23a4e36

Browse files
committed
Document the format of system package files
1 parent 1b3f001 commit 23a4e36

14 files changed

+99
-57
lines changed

build/pkgs/_prereq/distros/alpine.txt

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# This file, build/pkgs/_prereq/distros/alpine.txt, contains names of
2+
# Alpine Linux packages needed for installation of Sage from source.
3+
#
4+
# In addition, the files build/pkgs/SPKG/distros/alpine.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
6+
#
7+
# One package per line. No need to escape special characters.
8+
# Everything on a line after a # character is ignored.
9+
#
110
binutils
211
make
312
m4

build/pkgs/_prereq/distros/arch.txt

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# This file, build/pkgs/_prereq/distros/arch.txt, contains names of
2+
# Arch Linux packages needed for installation of Sage from source.
3+
#
4+
# In addition, the files build/pkgs/SPKG/distros/arch.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
6+
#
7+
# One package per line. No need to escape special characters.
8+
# Everything on a line after a # character is ignored.
9+
#
110
binutils
211
make
312
m4

build/pkgs/_prereq/distros/conda.txt

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# This file, build/pkgs/_prereq/distros/conda.txt, contains names of
2+
# conda packages needed for installation of Sage from source.
3+
#
4+
# In addition, the files build/pkgs/SPKG/distros/conda.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
6+
#
7+
# One package per line. No need to escape special characters.
8+
# Everything on a line after a # character is ignored.
9+
#
110
compilers
211
make
312
m4

build/pkgs/_prereq/distros/cygwin.txt

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# This file, build/pkgs/cygwin.txt, contains name Cygwin packages
2-
# needed for installation of Sage from source.
1+
# This file, build/pkgs/_prereq/distros/cygwin.txt, contains names of
2+
# Cygwin packages needed for installation of Sage from source.
33
#
4-
# In addition, the files build/pkgs/SPKG/cygwin.txt contain the names
5-
# of packages that provide the equivalent of SPKG.
6-
#
7-
# See build/bin/sage-spkg, where this information is processed
8-
# for use in "sage -info SPKG".
4+
# In addition, the files build/pkgs/SPKG/distros/cygwin.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
96
#
7+
# One package per line. No need to escape special characters.
108
# Everything on a line after a # character is ignored.
119
#
1210
binutils

build/pkgs/_prereq/distros/debian.txt

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
# This file, build/pkgs/debian.txt, contains names of Debian/Ubuntu packages
2-
# needed for installation of Sage from source.
1+
# This file, build/pkgs/_prereq/distros/debian.txt, contains names of
2+
# Debian/Ubuntu/... packages needed for installation of Sage from source.
33
#
4-
# In addition, the files build/pkgs/SPKG/debian.txt contain the names
5-
# of packages that provide the equivalent of SPKG.
6-
#
7-
# If distinctions between different distributions need to be made,
8-
# files named debian....txt or ubuntu.....txt can be used.
9-
#
10-
# See build/bin/sage-spkg, where this information is processed
11-
# for use in "sage -info SPKG".
4+
# In addition, the files build/pkgs/SPKG/distros/debian.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
126
#
7+
# One package per line. No need to escape special characters.
138
# Everything on a line after a # character is ignored.
9+
#
1410
binutils
1511
make
1612
m4

build/pkgs/_prereq/distros/fedora.txt

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
# This file, build/pkgs/fedora.txt, contains names of Fedora/Redhat/CentOS packages
2-
# needed for installation of Sage from source.
1+
# This file, build/pkgs/_prereq/distros/fedora.txt, contains names of
2+
# Fedora/Redhat/CentOS/AlmaLinux packages needed for installation
3+
# of Sage from source.
34
#
4-
# In addition, the files build/pkgs/SPKG/fedora.txt contain the names
5-
# of packages that provide the equivalent of SPKG.
6-
#
7-
# If distinctions between different distributions need to be made,
8-
# files named fedora....txt, redhat...txt, or centos....txt can be used.
9-
#
10-
# See build/bin/sage-spkg, where this information is processed
11-
# for use in "sage -info SPKG".
5+
# In addition, the files build/pkgs/SPKG/distros/fedora.txt contain
6+
# the names of packages that provide the equivalent of SPKG.
127
#
8+
# One package per line. No need to escape special characters.
139
# Everything on a line after a # character is ignored.
1410
#
1511
binutils

build/pkgs/_prereq/distros/freebsd.txt

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# This file, build/pkgs/freebsd.txt, contains names of FreeBSD packages
2-
# needed for installation of Sage from source.
1+
# This file, build/pkgs/_prereq/distros/freebsd.txt, contains names of
2+
# FreeBSD packages needed for installation of Sage from source.
33
#
44
# In addition, the files build/pkgs/SPKG/distros/freebsd.txt contain the
55
# names of packages that provide the equivalent of SPKG.
@@ -8,10 +8,9 @@
88
# $ cd /usr/ports/math/sage
99
# $ sudo make install-missing-packages
1010
#
11-
# See build/bin/sage-spkg, where this information is processed
12-
# for use in "sage -info SPKG".
13-
#
11+
# One package per line. No need to escape special characters.
1412
# Everything on a line after a # character is ignored.
13+
#
1514
gmake
1615
automake
1716
bash

build/pkgs/_prereq/distros/gentoo.txt

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# This file, build/pkgs/_prereq/distros/gentoo.txt, contains names of
2+
# Gentoo packages needed for installation of Sage from source.
3+
#
4+
# In addition, the files build/pkgs/SPKG/distros/gentoo.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
6+
#
7+
# One package per line. No need to escape special characters.
8+
# Everything on a line after a # character is ignored.
9+
#
110
sys-devel/binutils
211
sys-libs/binutils-libs
312
sys-devel/make
+6-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# This file, build/pkgs/homebrew.txt, contains names of homebrew packages
2-
# needed for installation of Sage from source (in addition to XCode).
1+
# This file, build/pkgs/_prereq/distros/homebrew.txt, contains names of
2+
# Homebrew packages needed for installation of Sage from source.
33
#
4-
# In addition, the files build/pkgs/SPKG/homebrew.txt contain the names
5-
# of packages that provide the equivalent of SPKG.
6-
#
7-
# See build/bin/sage-spkg, where this information is processed
8-
# for use in "sage -info SPKG".
4+
# In addition, the files build/pkgs/SPKG/distros/homebrew.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
96
#
7+
# One package per line. No need to escape special characters.
108
# Everything on a line after a # character is ignored.
9+
#
1110

1211
# No packages needed

build/pkgs/_prereq/distros/nix.txt

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
# This file, build/pkgs/debian.txt, contains names of Debian/Ubuntu packages
2-
# needed for installation of Sage from source.
1+
# This file, build/pkgs/_prereq/distros/nix.txt, contains names of
2+
# nix packages needed for installation of Sage from source.
33
#
4-
# In addition, the files build/pkgs/SPKG/debian.txt contain the names
5-
# of packages that provide the equivalent of SPKG.
6-
#
7-
# If distinctions between different distributions need to be made,
8-
# files named debian....txt or ubuntu.....txt can be used.
9-
#
10-
# See build/bin/sage-spkg, where this information is processed
11-
# for use in "sage -info SPKG".
4+
# In addition, the files build/pkgs/SPKG/distros/nix.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
126
#
7+
# One package per line. No need to escape special characters.
138
# Everything on a line after a # character is ignored.
9+
#
1410
binutils
1511
gnumake
1612
gnum4

build/pkgs/_prereq/distros/opensuse.txt

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# This file, build/pkgs/opensuse.txt, contains names of OpenSuse packages
2-
# needed for installation of Sage from source.
1+
# This file, build/pkgs/_prereq/distros/opensuse.txt, contains names of
2+
# OpenSuse packages needed for installation of Sage from source.
33
#
4-
# In addition, the files build/pkgs/SPKG/opensuse.txt contain the names
5-
# of packages that provide the equivalent of SPKG.
6-
#
7-
# See build/bin/sage-spkg, where this information is processed
8-
# for use in "sage -info SPKG".
4+
# In addition, the files build/pkgs/SPKG/distros/opensuse.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
96
#
7+
# One package per line. No need to escape special characters.
108
# Everything on a line after a # character is ignored.
9+
#
1110
binutils
1211
make
1312
m4

build/pkgs/_prereq/distros/slackware.txt

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# This file, build/pkgs/_prereq/distros/slackware.txt, contains names of
2+
# Slackware packages needed for installation of Sage from source.
3+
#
4+
# In addition, the files build/pkgs/SPKG/distros/slackware.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
6+
#
7+
# One package per line. No need to escape special characters.
8+
# Everything on a line after a # character is ignored.
9+
#
110
binutils
211
make
312
# dependencies of make

build/pkgs/_prereq/distros/void.txt

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# This file, build/pkgs/_prereq/distros/void.txt, contains names of
2+
# Void Linux packages needed for installation of Sage from source.
3+
#
4+
# In addition, the files build/pkgs/SPKG/distros/void.txt contain
5+
# the names of packages that provide the equivalent of SPKG.
6+
#
7+
# One package per line. No need to escape special characters.
8+
# Everything on a line after a # character is ignored.
9+
#
110
bc
211
binutils
312
gcc

src/doc/en/developer/packaging.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -512,10 +512,15 @@ containing files with names like ::
512512
arch.txt
513513
conda.txt
514514
debian.txt
515+
fedora.txt
515516
homebrew.txt
516517
...
517518
518-
corresponding to different packaging systems.
519+
corresponding to different packaging systems. Each system package
520+
should appear on a separate line. If the shell-style variable reference
521+
``${PYTHON_MINOR}`` appears, it is replaced by the minor version of
522+
Python, e.g., 12 for Python 3.12.x. Everything on a line after a ``#``
523+
character is ignored, so comments can be included in the files.
519524
520525
For example, if ``./configure`` detects that the Homebrew packaging
521526
system is in use, and if the current package can be provided by a

0 commit comments

Comments
 (0)