#9419: Update Developers Guide to state how patches should be made.
---------------------------------------------------+------------------------
Reporter: drkirkby | Owner: mvngu
Type: enhancement | Status:
needs_work
Priority: major | Milestone: sage-4.8
Component: documentation | Keywords: patch doc
howto spkgs diff
Work_issues: finance.py.patch in too many places | Upstream: N/A
Reviewer: Karl-Dieter Crisman | Author: John
Palmieri
Merged: | Dependencies:
---------------------------------------------------+------------------------
Changes (by newvalueoldvalue):
* status: needs_review => needs_work
* reviewer: => Karl-Dieter Crisman
* work_issues: => finance.py.patch in too many places
* author: => John Palmieri
Comment:
> > One tiny request.
>
> Okay, here's part 2 of the patch, which addresses your suggestions.
Wow, great! Looks good, applies to alpha4 fine, builds and doc looks
great.
As I said, I don't feel comfortable addressing the shell stuff, but I like
this. Here are a few tiny things.
* Syntax:
{{{
sage -f /URL/to/package-x.y.z.spkg
}}}
Maybe, just to be pedantic,
{{{
sage -f http://URL/to/package-x.y.z.spkg
}}}
Or maybe that will cause more confusion than the original one...
* One actual error I found, I think.
{{{
matplotlib-1.0.1.p0/src/lib/matplotlib/finance.py.patch
}}}
I think that should just be finance.py, right? Should be easy to
refresh the `part2.patch`, I hope. Sorry.
* And a teensy teensy thing:
{{{
A main message of this section is
}}}
should that be `The main`? I realize this is "legacy documentation",
but might as well spruce it up.
* A question, probably due to ignorance:
{{{
diff -u src/configure src-patched/configure > patches/configure.patch
}}}
will that make a patch that actually applies correctly? I feel like
this will produce one with a header that says
{{{
--- a/src/configure
+++ b/src-patched/configure
}}}
that wouldn't apply, as opposed to
{{{
--- a/src/configure
+++ b/src/configure
}}}
----
Otherwise, here are things that need to be reviewed that I don't feel
comfortable doing, though I'm sure they are right.
* the argument about `diff -u` versus `diff -Naur`
* the `[[ -z "$SAGE_LOCAL" ]]` change
* Changing to `--` instead of `-` for options to commands, like `sage
--pkg`.
* `cp -pR`
* `patch -p1 <"$patch"` versus `patch -p1 < "$patch"` (the latter is
probably just my imagination, but I know that shell script cares about
spaces at times) and in general verifying that that is the correct syntax,
though I'm sure it is based on seeing various of Leif's spkgs
Anyone who uses these a lot can check them off as correct and this can go
in.
----
Regarding "a" versus "an".
> The letter 's' is certainly a consonant, and not a vowel, and I don't
think 'spkg' sounds like a vowel (as for example 'hour' does, despite it
starting with a consonant). So I would have thought it should have been "a
spkg" and not "an spkg". But it's not a big deal.
Ah, but I've never heard "spkg" pronounced other than as "esspackage".
Vowel sound. Sort of like how different people will say "an (h)istorical"
or "a historical", and both are right.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9419#comment:22>
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.