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: Update sdh_... documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Koeppe committed Sep 17, 2020
1 parent 9ee2110 commit d7aac84
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions src/doc/en/developer/packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,12 +368,26 @@ begin with ``sdh_``, which stands for "Sage-distribution helper".
arguments. If ``$SAGE_DESTDIR`` is not set then the command is run
with ``$SAGE_SUDO``, if set.
- ``sdh_pip_install [...]``: Runs ``pip install`` with the given
arguments, as well as additional default arguments used for
installing packages into Sage with pip. Currently this is just a
wrapper around the ``sage-pip-install`` command. If
``$SAGE_DESTDIR`` is not set then the command is run with
``$SAGE_SUDO``, if set.
- ``sdh_pip_install [...]``: The equivalent of running ``pip install``
with the given arguments, as well as additional default arguments used for
installing packages into Sage with pip. The last argument must be
``.`` to indicate installation from the current directory.
``sdh_pip_install`` actually does the installation via ``pip wheel``,
creating a wheel file in ``dist/``, followed by
``sdh_store_and_pip_install_wheel`` (see below).
- ``sdh_store_and_pip_install_wheel .``: The current directory,
indicated by the required argument ``.``, must have a subdirectory
``dist`` containing a unique wheel file (``*.whl``).
This command (1) moves this wheel file to the
directory ``$SAGE_SPKG_WHEELS`` (``$SAGE_LOCAL/var/lib/sage/wheels``)
and then (2) installs the wheel in ``$SAGE_LOCAL``.
Both of these steps, instead of writing directly into ``$SAGE_LOCAL``,
use the staging directory ``$SAGE_DESTDIR`` if set; otherwise, they
use ``$SAGE_SUDO`` (if set).
- ``sdh_install [-T] SRC [SRC...] DEST``: Copies one or more files or
directories given as ``SRC`` (recursively in the case of
Expand Down

0 comments on commit d7aac84

Please sign in to comment.