#16048: dev docs: Inclusion Procedure for New and Updated Packages
-------------------------------------+-------------------------------------
Reporter: rws | Owner:
Type: defect | Status: needs_work
Priority: major | Milestone: sage-6.2
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Ralf Stephan | Reviewers: R. Andrew Ohanar,
Report Upstream: N/A | Jeroen Demeyer, Vincent Delecroix
Branch: public/spkg- | Work issues:
devdoc-1 | Commit:
Dependencies: | b0a7ee5d74544e793db3c907de8900895b2513c9
| Stopgaps:
-------------------------------------+-------------------------------------
Comment (by rws):
Thanks for your review.
Replying to [comment:14 vdelecroix]:
> I am very sorry to be very picky
Don't.
> As it is the case in all other sections, it would be nice if you add a
line break after the title.
Done.
> - experimental = does not build on all platforms officially supported
=> never be optional
Yes, done.
> The sentence "In short, packages consist of a link to the original
tarball with additional
> code under !``SAGE_ROOT/build/pkgs!``" is not meaningful at this stage
of the document. It is not clear what is a "package" nor what is an
"original tarball". I would simply remove the sentence as this section is
purely about "how do you submit" and not "how do you make your own
package".
Done.
> Moreover, I would would better put this section near the end of the
document because before submitting a package you need to build one ;-).
I was not sure how to do this.
> In the sentence "to package it in Sage" you must uppercase the "t". At
the very same place I suggest to put a comment in parenthesis "...
distribute a tarball !``foo-1.3.tar.gz!`` (that will be automatically
placed in !``SAGE_ROOT/upstream!`` during the installation process)" or
something similar.
Both done.
> {{{
> $ SAGE_CHECK=yes sage -f package_name
> }}}
> will not do what you expect.
I replaced it with {{{sage -i -c PACKAGE_NAME}}}.
> There are at least 5 important missing things:
I was unsure how to include this. Please feel free to add it and the other
issue above yourself.
--
Ticket URL: <http://trac.sagemath.org/ticket/16048#comment:16>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
