#12609: Update developer guide for SPKGs
---------------------------------------------+------------------------------
Reporter: jdemeyer | Owner: mvngu
Type: defect | Status: positive_review
Priority: minor | Milestone: sage-5.0
Component: documentation | Keywords:
Work_issues: | Upstream: N/A
Reviewer: Jeroen Demeyer, John Palmieri | Author: John Palmieri,
Jeroen Demeyer
Merged: | Dependencies:
---------------------------------------------+------------------------------
Changes (by jhpalmieri):
* status: needs_review => positive_review
* reviewer: Jeroen Demeyer => Jeroen Demeyer, John Palmieri
Old description:
> This ticket is about updating the developer guide for #10492.
>
> The developer guide suggests
> (http://sagemath.org/doc/developer/producing_spkgs.html#the-file-spkg-
> txt)
> {{{
> If your package depends on another package, say boehmgc, then you
> should check that this other package has been installed. Your spkg-
> install script should check that it exists, with code like the following:
>
> BOEHM_GC=`cd $SAGE_ROOT/spkg/standard/; ./newest_version boehm_gc`
> if [ $? -ne 0 ]; then
> echo "Failed to find boehm_gc. Please install the boehm_gc
> spkg"
> exit 1
> fi
> }}}
> This is totally wrong. It only checks that a spkg ''exists'', not that
> it has been installed. See #12608 for removing this wrong checking from
> PPL.
>
> The patches below also include various fixes to "Producing New Sage
> Packages".
>
> Apply [attachment:trac_12609-doc-developer.patch] and
> [12609_review.patch] to the main Sage library.
New description:
This ticket is about updating the developer guide for #10492.
The developer guide suggests
(http://sagemath.org/doc/developer/producing_spkgs.html#the-file-spkg-txt)
{{{
If your package depends on another package, say boehmgc, then you
should check that this other package has been installed. Your spkg-install
script should check that it exists, with code like the following:
BOEHM_GC=`cd $SAGE_ROOT/spkg/standard/; ./newest_version boehm_gc`
if [ $? -ne 0 ]; then
echo "Failed to find boehm_gc. Please install the boehm_gc
spkg"
exit 1
fi
}}}
This is totally wrong. It only checks that a spkg ''exists'', not that it
has been installed. See #12608 for removing this wrong checking from PPL.
The patches below also include various fixes to "Producing New Sage
Packages".
Apply [attachment:trac_12609-doc-developer.patch] and
[attachment:12609_review.patch] to the main Sage library.
--
Comment:
I wouldn't mind a change like the following, but with or with this the
reviewer patch gets a positive review.
{{{
#!diff
diff --git a/doc/en/developer/producing_spkgs.rst
b/doc/en/developer/producing_spk
--- a/doc/en/developer/producing_spkgs.rst
+++ b/doc/en/developer/producing_spkgs.rst
@@ -34,7 +34,8 @@ Sage packages are distributed as ``.spkg
to discourage confusion. Although Sage packages are packed using tar
and/or bzip2, note that ``.spkg`` files contain control information
(installation scripts and metadata) that are necessary for building
-and installing them. When you compile Sage from a source distribution,
+and installing them. When you compile Sage from a source
+distribution, or when you run ``sage -i <pkg>`` or ``sage -f <pkg>``,
the file ``SAGE_ROOT/spkg/bin/sage-spkg`` takes care of the unpacking,
compilation, and installation of Sage packages for you. You can
type
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12609#comment:9>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
