Opened 11 years ago

Closed 5 years ago

#4857 closed enhancement (wontfix)

script to create spkg template

Reported by: GeorgSWeber Owned by: GeorgSWeber
Priority: minor Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords:
Cc: Merged in:
Authors: Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

(see also the respective thread at sage-devel)

Although this spkg is pretty small, putting it in a trac ticket is probably not the best idea. But currently, I haven't got access to any other web space where I could place it.

Install with "sage -i exampleclib-1.0.0.spkg"; the documentation is the under

$SAGE_ROOT/devel/exampleclib/src/README.txt

$SAGE_ROOT/devel/exampleclib/src/doc/*

Attachments (3)

4857-scripts.patch (6.2 KB) - added by GeorgSWeber 11 years ago.
a new script "sage-create-spkg" to go in the scripts repo /local/bin
4857-examples.patch (5.8 KB) - added by GeorgSWeber 11 years ago.
two example "upstream src" packages (sample spkg input) to go in the examples/ repo
4857-doc.patch (12.6 KB) - added by GeorgSWeber 11 years ago.
rewritten and enhanced chapter about spkg in prog.tex resp. the doc/ repo (probably rather easily rebased after the ReST move)

Download all attachments as: .zip

Change History (15)

comment:1 Changed 11 years ago by mabshoff

-1 by a wide margin. This spkg does numerous things badly and introduces many "features" we don't need or are completely overdesigned. The idea about spkg-install and its friends is KISS and this certainly isn't it.

The place to have this is not trac either.

Cheers,

Michael

comment:2 Changed 11 years ago by mabshoff

I have removed the attached spkg. It can now be found at

http://sage.math.washington.edu/home/mabshoff/exampleclib-1.0.0.spkg

Cheers,

Michael

Changed 11 years ago by GeorgSWeber

a new script "sage-create-spkg" to go in the scripts repo /local/bin

Changed 11 years ago by GeorgSWeber

two example "upstream src" packages (sample spkg input) to go in the examples/ repo

Changed 11 years ago by GeorgSWeber

rewritten and enhanced chapter about spkg in prog.tex resp. the doc/ repo (probably rather easily rebased after the ReST move)

comment:3 Changed 11 years ago by GeorgSWeber

  • Component changed from experimental package to documentation
  • Milestone changed from sage-wishlist to sage-3.4
  • Summary changed from [with spkg, needs discussion] Example C Library to [with patches, needs review] spkg development documentation and handling

The current documentation in the Sage Developer's Guide says in Chapter 2, subsection 8.1, item (f) about Creating a New spkg: ... Post a copy on the Sage trac server ...

This is outdated. I took the opportunitiy to rewrite subsection 8.1, add two subsections 8.2 and 8.3, and assemble two live examples (to go under the examples directory) and a script "sage-create-spkg" which e.g. creates a template SPKG.txt and the mandatory hg repo. The script called on the examples result in working spkg, that install fine.

Well, at least at the author's Mac. So it would be good if the referee could use and test it on a Linux machine.

The contents are based on a discussion with Michael Abshoff on sage-devel, half of the credit (at least) goes to him. All the remaining mistakes are mine, of course :-)

comment:4 Changed 11 years ago by was

  • Summary changed from [with patches, needs review] spkg development documentation and handling to [with patches, needs work] spkg development documentation and handling

MABSHOFF:

"I think in its current form 4857-examples.patch should not go in, in fact it shouldn't go in at all IMHO.

4857-scripts.patch is too complicated IMHO, but salvageable."

So I change this to "needs work".

comment:5 Changed 11 years ago by jhpalmieri

See #5990 for a closely related ticket -- a patch to the documentation, based in large part on 4857-doc.patch.

comment:6 Changed 10 years ago by mvngu

  • Report Upstream set to N/A
  • Summary changed from [with patches, needs work] spkg development documentation and handling to script to create spkg template

Documentation on producing a new spkg is already in the Developers' Guide in the form of the section Producing New Sage Packages. Tickets #8079 and #8104 add documentation on patching an existing spkg. So I think the subject of this ticket can be changed to something else other than documentation on producing spkg's.

comment:7 Changed 6 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:8 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:9 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:10 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4

comment:11 Changed 5 years ago by jdemeyer

  • Milestone changed from sage-6.4 to sage-duplicate/invalid/wontfix
  • Reviewers set to Jeroen Demeyer
  • Status changed from needs_work to positive_review

Obsolete by the git transition.

comment:12 Changed 5 years ago by vbraun

  • Resolution set to wontfix
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.