Ticket #9419: trac_9419-part2.patch

File trac_9419-part2.patch, 4.0 KB (added by jhpalmieri, 10 years ago)
  • doc/en/developer/patching_spkgs.rst

    # HG changeset patch
    # User J. H. Palmieri <palmieri@math.washington.edu>
    # Date 1324329630 28800
    # Node ID dacb4ea8712ea510106d687b92352be55163d8ae
    # Parent  631821a26796c74da14b093f0e129b18e260c9ad
    #9419: documentation on format of SPKG.txt, and using "hg tag"
    
    diff --git a/doc/en/developer/patching_spkgs.rst b/doc/en/developer/patching_spkgs.rst
    a b the file :: 
    7474
    7575is a patch for the file ::
    7676
    77     matplotlib-1.0.1.p0/src/lib/matplotlib/finance.py.patch
     77    matplotlib-1.0.1.p0/src/lib/matplotlib/finance.py
    7878
    7979The installation script ``matplotlib-1.0.1.p0/spkg-install`` contains the
    8080following code to install the relevant patches::
    8181
     82    cd src
     83
    8284    # Apply patches.  See SPKG.txt for information about what each patch
    8385    # does.
    8486    for patch in ../patches/*.patch; do
    For example:: 
    106108(The environment variable :envvar:`UNAME` is defined by the script
    107109``sage-env``, and is available when ``spkg-install`` is run.)
    108110
    109 Now provide a high-level explanation of your changes in
    110 ``SPKG.txt``. Once you are satisfied with your changes, use Mercurial
    111 to check in your changes with a meaningful commit message. Next,
    112 increment the patch level of the spkg by one, e.g. rename the
    113 directory ``matplotlib-1.0.1.p0`` to ``matplotlib-1.0.1.p1``.  To
    114 produce the actual spkg file, change to the parent directory of
     111Now provide a high-level explanation of your changes in ``SPKG.txt``.
     112Note the format of ``SPKG.txt`` -- see the chapter :ref:`chapter-spkg`
     113for details.  Once you are satisfied with your changes, use Mercurial
     114to check in your changes with a meaningful commit message.  Then use
     115the command ``hg tag`` to tag the tip with the new version number
     116(using "p1" instead of "p0": we have made changes, so we need to
     117update the patch level)::
     118
     119    $ hg tag matplotlib-1.0.1.p1
     120
     121Next, rename the directory ``matplotlib-1.0.1.p0`` to
     122``matplotlib-1.0.1.p1`` to match the new patch level.  To produce the
     123actual spkg file, change to the parent directory of
    115124``matplotlib-1.0.1.p1`` and execute ::
    116125
    117126    $ /path/to/sage-x.y.z/sage --pkg matplotlib-1.0.1.p1
    binary files to the trac server. 
    155164Use patch for patching
    156165======================
    157166
    158 A main message of this section is: use the GNU program ``patch`` to
     167The main message of this section is: use the GNU program ``patch`` to
    159168apply patches to files in ``src/``.  GNU patch is distributed with
    160169Sage, so if you are writing an spkg which is not part of the standard
    161170Sage distribution, you may use ``patch`` in the ``spkg-install``
    bzip2). 
    201210
    202211To install your replacement spkg, you use ::
    203212
    204     sage -f /URL/to/package-x.y.z.spkg
     213    sage -f http://URL/to/package-x.y.z.spkg
    205214
    206215or ::
    207216
  • doc/en/developer/producing_spkgs.rst

    diff --git a/doc/en/developer/producing_spkgs.rst b/doc/en/developer/producing_spkgs.rst
    a b The ``SPKG.txt`` file should follow this 
    294294
    295295     == SPKG Maintainers ==
    296296
    297      List the maintainers here
     297     Put a bulleted list of the maintainers of the SPKG here:
     298
     299     * Mary Smith
     300     * Bill Jones
     301     * Leonhard Euler
    298302
    299303     == Upstream Contact ==
    300304
    The ``SPKG.txt`` file should follow this 
    302306
    303307     == Dependencies ==
    304308
    305      List the dependencies here
     309     Put a bulleted list of dependencies here:
     310
     311     * python
     312     * readline
    306313
    307314     == Special Update/Build Instructions ==
    308315
    The ``SPKG.txt`` file should follow this 
    310317
    311318     == Changelog ==
    312319
    313      Provide a changelog of the spkg here.
     320     Provide a changelog of the spkg here, where the entries have this format:
    314321
     322     === mypackage-0.1.p0 (Mary Smith, 1 Jan 2012) ===
     323
     324      * Patch src/configure so it builds on Solaris. See Sage trac #137.
     325 
     326     === mypackage-0.1 (Leonhard Euler, 17 September 1783) ===
     327
     328      * Initial release.  See Sage trac #007.
     329 
    315330When the directory (say, ``mypackage-0.1``) is ready, the command
    316331
    317332::