Dummy package _sagemath: record downstream package of Sage in distributions

[mkoeppe]

To generate info for src/doc/en/installation/linux.rst and to provision devcontainers that launch downstream Sage as packaged by distributions (as done in #33671 for archlinux, conda)

Depends on #34252

CC: @antonio-rojas @kiwifb @isuruf @collares @tornaria @tobihan @jhpalmieri @seblabbe @nbruin @kwankyu

Component: documentation

Author: Matthias Koeppe

Branch/Commit: 4280369

Reviewer: Kwankyu Lee

Issue created by migration from https://trac.sagemath.org/ticket/33870

[mkoeppe]

Branch: u/mkoeppe/dummy_script_packagesagemathrecord_downstream_package_of_sage_in_distributions

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Commit: fc06250

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

fc06250

build/pkgs/_sagemath: New

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from fc06250 to a2557d4

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

a2557d4

build/pkgs/_sagemath/distros/debian.txt: Move debian info here from src/doc/en/installation/linux.rst

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,3 +1,3 @@
-To generate info in `src/doc/en/installation/linux.rst`
+To generate info for `src/doc/en/installation/linux.rst`
 and to provision devcontainers that launch downstream Sage as packaged by distributions (as done in #33671 for archlinux, conda)

[mkoeppe]

comment:4

I have taken the information about the packages from repology; please help to make this information accurate

Also https://trac.sagemath.org/wiki/Distribution#Packagemanagers probably needs updating - I've come across some broken links etc.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from a2557d4 to 3dd0d18

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

3dd0d18

build/pkgs/_sagemath/type: New

[mkoeppe]

Author: Matthias Koeppe, ...

[mkoeppe]

Changed author from Matthias Koeppe, ... to Matthias Koeppe

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

9d1e07a	Revive furo
f19b597	Add link to the logo
09d5f5c	Fix the logo link for reference
ae75d53	Fix a subtle reference problem for build_options
3519bed	Run docbuild workflow with single thread
1274718	Fix a suspicious part of categories doc
e5b1f7e	Add search.html
ebd3b77	Better pygments style
73e5aa3	Make white logo transparent to match with furo
05d909c	Merge #34252

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 3dd0d18 to 05d909c

[mkoeppe]

Dependencies: #34252

[kwankyu]

comment:11

diff --git a/build/pkgs/_sagemath/SPKG.rst b/build/pkgs/_sagemath/SPKG.rst
index c0021422ad..5f38af716d 100644
--- a/build/pkgs/_sagemath/SPKG.rst
+++ b/build/pkgs/_sagemath/SPKG.rst
@@ -12,4 +12,4 @@ including documentation and Jupyter.
 Downstream Contact
 ------------------

-See https://trac.sagemath.org/wiki/Distribution#Packagemanagers
+See :trac:`wiki/Distribution#Packagemanagers`.

[kwankyu]

comment:12

Before the above change, there was an error in building the documentation. But with the above change, it shows as

See trac ticket #wiki/Distribution#Packagemanagers.

[mkoeppe]

comment:13

Somewhere else we use

:trac:`Trac wiki page Distribution <wiki/Distribution>`

I'll change it to that.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

7cc2e57

build/pkgs/_sagemath/SPKG.rst: Fix markup of trac wiki link

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 05d909c to 7cc2e57

[kwankyu]

comment:15

These "dummy script packages" might be of type "dummy" so that they are not mixed with real standard and optional packages.

[kwankyu]

comment:16

Please leave "dependencies" blank instead of "none". It will look better.

[kwankyu]

comment:17

Could a dummy package be really installable? Specifically, how about "_recommended" package?

[mkoeppe]

comment:18

The word "None" is generated by build/bin/sage-spkg-info. Do you suggest I should change that and leave the "Dependencies" section blank in general in this case?

[mkoeppe]

comment:19

No, dummy packages are not installable. That's what makes them dummy. _recommended is not installable either

[kwankyu]

comment:20

Then the type of a dummy package is not significant?

[kwankyu]

comment:21

Replying to @mkoeppe:

The word "None" is generated by build/bin/sage-spkg-info. Do you suggest I should change that and leave the "Dependencies" section blank in general in this case?

For documentation look and feel, yes. But if you think "None" is better for other considerations, then I would not insist.

[mkoeppe]

comment:22

The output is only about look and feel. I'll change it.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

3392763

build/bin/sage-spkg-info: Do not print 'None' when there are no dependencies

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 7cc2e57 to 3392763

[mkoeppe]

comment:24

Replying to @kwankyu:

Then the type of a dummy package is not significant?

I think they are all "optional", there's no additional distinction

[kwankyu]

comment:25

Replying to @kwankyu:

These "dummy script packages" might be of type "dummy" so that they are not mixed with real standard and optional packages.

Just an idea for another ticket...

[mkoeppe]

comment:26

I'd say "dummy script" is a "source type", not a "package type", see https://doc.sagemath.org/html/en/developer/packaging.html#package-source-types

[mkoeppe]

comment:27

Replying to @mkoeppe:

Replying to @kwankyu:

Then the type of a dummy package is not significant?

I think they are all "optional", there's no additional distinction

Except for _prereq, which is a standard dummy script package.

[kwankyu]

comment:28

Replying to @mkoeppe:

I'd say "dummy script" is a "source type", not a "package type", see https://doc.sagemath.org/html/en/developer/packaging.html#package-source-types

But "dummy package" is a package type.

More seriously it seems that the last two lines are also auto-generated, and not suitable for a dummy package.

...
nix:

$ nix-env --install sage
void:

$ sudo xbps-install  sagemath
See https://repology.org/project/sagemath/versions

However, these system packages will not be used for building Sage 
because spkg-configure.m4 has not been written for this package; see trac ticket #27330

So these dummy packages really should be treated separately. But for this, later.

There is a typo:

See <../reference/spkg/index.html>`_ for the names of packages ...

Missing apostrophe?

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 3392763 to ef7732f

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

ef7732f

src/doc/en/installation/linux.rst: Fix markup

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

6bf421e

src/doc/en/developer/packaging.rst: Explain dummy packages

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from ef7732f to 6bf421e

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 6bf421e to 4280369

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Branch pushed to git repo; I updated commit sha1. New commits:

4280369

Change 'dummy script package' to just 'dummy package'

[kwankyu]

comment:32

Thanks for updating stuffs for dummy packages.

It looks good to me.

[kwankyu]

Reviewer: Kwankyu Lee

[mkoeppe]

comment:34

Thank you!

[vbraun]

Changed branch from u/mkoeppe/dummy_script_packagesagemathrecord_downstream_package_of_sage_in_distributions to 4280369