#4504: [with patches, needs work] document Sage's .spkg extension better
--------------------------------------------+-------------------------------
Reporter: mvngu | Owner: was
Type: defect | Status: new
Priority: minor | Milestone: sage-3.2.2
Component: documentation | Resolution:
Keywords: .spkg extension, Sage packages |
--------------------------------------------+-------------------------------
Changes (by was):
* summary: [with patches, needs review] document Sage's .spkg extension
better => [with patches, needs work] document
Sage's .spkg extension better
Comment:
Hi,
Right now in a fresh install of sage-3.2.2.alpha0, there is a README.txt
file in spkg/standard/. It is simply an OLD out-of-date version of the
README.txt file in SAGE_ROOT. I think it should be completely deleted.
Then a file README.txt in the spkg directory should be created with two
short sections, and those sections should contain the text mvngu wrote.
That's it.
I'm not convinced about having all the extra infrastructure for two
separate readme's for the source and binary versions of Sage. Even if
that is a good idea, it could be a separate ticket, since as is, this
ticket would not be in "with patch; needs review" status if that extra
stuff has to be done.
So in short, I suggest doing the following:
1. (see attached patch trac_4504_scripts.patch) Add the line
{{{
cp -p $PKGDIR/README.txt $TMP/$PKGDIR/
}}}
as line 64 of local/bin/sage-sdist. The analogue of this is currently
already done in sage-bdist (line 90).
2. Delete spkg/standard/README.txt
3. Make a new spkg/README.txt file that has two sections, one for each
of Minh's patches.
By the way, it's been suggested above that the spkg/standard/*.spkg files
are empty in a bdist. They aren't empty. They contain the single
sentence: "Placeholder spkg file so this binary version of Sage knows this
package version used when installing Sage."
Also, I have issues with the actual wording of mvngu's patch, which is:
{{{
4 If you've downloaded a binary distribution of Sage, you'd likely
see
5 a number of files with the extension ".spkg" under the directory
6 SAGE_ROOT/spkg. In a binary distribution of Sage, such files are
empty
7 files and you don't need to do anything about them. Just ignore
such
8 files for the moment.
9
10 However, note that in a source distribution of Sage, .spkg files
under
11 SAGE_ROOT/spkg are core Sage packages, which extend Sage's
12 functionalities.
}}}
First, there are no spkg files in SAGE_ROOT/spkg; they are in
SAGE_ROOT/spkg/standard/.
Second, it's not "likely" -- they will always be there with probability 1.
Third, they aren't empty, as mentioned above.
Fourth, in the case of source they don't "extend Sage's functionalities",
they *are* the source code that defines Sage. So I would replace all
the above with:
{{{
The directories SAGE_ROOT/spkg/standard and SAGE_ROOT/spkg/optional
contain spkg's.
In a source install, these are all Sage spkg files (actually .tar or
.tar.bz2 files), which are the source code that defines Sage. In a binary
install some of these may be small placeholder files to save space.
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4504#comment:12>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
