From b401649578c412275b9e79fbac235c4421837688 Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Thu, 24 Feb 2022 17:09:16 -0800 Subject: [PATCH] src/doc/en/developer/packaging.rst: Explain package tags has_nonfree_dependencies, huge --- src/doc/en/developer/packaging.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/doc/en/developer/packaging.rst b/src/doc/en/developer/packaging.rst index aaa294986d1..6618c7b5930 100644 --- a/src/doc/en/developer/packaging.rst +++ b/src/doc/en/developer/packaging.rst @@ -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 @@ -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