Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
src/doc/en/developer/packaging.rst: Explain package tags has_nonfree_…
Browse files Browse the repository at this point in the history
…dependencies, huge
  • Loading branch information
Matthias Koeppe committed Feb 25, 2022
1 parent 554ad59 commit b401649
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/doc/en/developer/packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ The following are some additional files which can be added:
|-- distros
| |-- platform1.txt
| `-- platform2.txt
|-- has_nonfree_dependencies
|-- huge
|-- patches
| |-- bar.patch
| `-- baz.patch
Expand Down Expand Up @@ -729,6 +731,23 @@ packages and optional packages should only depend on standard or
optional packages.
.. _section-spkg-tags:
You can mark a package as "huge" by placing an empty file named
``huge`` in the package directory. For example, the package
``polytopes_db_4d`` is a large database whose compressed tarball has a
size of 9 GB.
For some other packages, we have placed an empty file named
``has_nonfree_dependencies`` in the package directory. This is to
indicate that Sage with this package installed cannot be
redistributed, and also that the package can only be installed after
installing some other, non-free package.
We use these tags in our continuous integration scripts to filter
out packages that we cannot or should not test automatically.
.. _section-trees:
Where packages are installed
Expand Down

0 comments on commit b401649

Please sign in to comment.