Skip to content

Commit 42dd5cc

Browse files
author
Matthias Koeppe
committed
src/doc/en/developer/packaging.rst: Document the new tags
1 parent 62cef34 commit 42dd5cc

File tree

2 files changed

+26
-12
lines changed

2 files changed

+26
-12
lines changed

src/doc/bootstrap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
8686
fi
8787
OUTPUT_INDEX="$OUTPUT_DIR"/index.rst
8888
cat > "$OUTPUT_INDEX" <<EOF
89+
.. _spkg:
8990
9091
Packages and Features
9192
=====================

src/doc/en/developer/packaging.rst

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -776,20 +776,33 @@ optional packages.
776776
Package tags
777777
------------
778778
779-
You can mark a package as "huge" by placing an empty file named
780-
``huge`` in the package directory. For example, the package
781-
``polytopes_db_4d`` is a large database whose compressed tarball has a
782-
size of 9 GB.
783-
784-
For some other packages, we have placed an empty file named
785-
``has_nonfree_dependencies`` in the package directory. This is to
786-
indicate that Sage with this package installed cannot be
787-
redistributed, and also that the package can only be installed after
788-
installing some other, non-free package.
789-
790-
We use these tags in our continuous integration scripts to filter
779+
We use the following "tags" to organize our :ref:`index of packages in the
780+
Reference Manual <spkg>`.
781+
782+
- Place an empty file named ``math`` in the package directory to make the
783+
package appear in the "Mathematics" subsections of the index of standard,
784+
optional, and experimental packages.
785+
786+
- Place an empty file name ``front-end`` in the package directory to make
787+
the package appear in the "Front-end, graphics, document preparation"
788+
subsections.
789+
790+
- Packages without these tags appear in the "Other dependencies" subsections.
791+
792+
We use the following tags in our continuous integration scripts to filter
791793
out packages that we cannot or should not test automatically.
792794
795+
- You can mark a package as "huge" by placing an empty file named
796+
``huge`` in the package directory. For example, the package
797+
``polytopes_db_4d`` is a large database whose compressed tarball has a
798+
size of 9 GB.
799+
800+
- For some other packages, we have placed an empty file named
801+
``has_nonfree_dependencies`` in the package directory. This is to
802+
indicate that Sage with this package installed cannot be
803+
redistributed, and also that the package can only be installed after
804+
installing some other, non-free package.
805+
793806
794807
.. _section-trees:
795808

0 commit comments

Comments
 (0)