sandbox/infrastructure/README.txt

   1 ==========================
   2  Docutils_ Infrastructure
   3 ==========================
   4
   5 :Author: Lea Wiemann
   6 :Contact: grubert@users.sourceforge.net
   7 :Revision: $Revision$
   8 :Date: $Date$
   9 :Copyright: This document has been placed in the public domain.
  10
  11
  12 The `infrastructure <.>`_ sandbox directory stores any scripts that
  13 are needed for the development of the Docutils project.
  14
  15 :`<docutils-update.local>`_: The script to update the `web site`_
  16     from a developer machine or on shell.sourceforge.
  17
  18     If a file ``ON_SOURCEFORGE`` exists in current dorectory, the
  19     script assumes being executed on shell.sourceforge.
  20
  21 :`<release.sh>`_: The script to make releases_ of Docutils.
  22     For usage details see `<release.txt>`_
  23
  24     TODO : test.
  25       Allow release without testing, because tests must be done
  26       on more than one os.
  27
  28 :`<release-test.sh>`_: The script to run tests at release time, extracted
  29     from ``release.sh``.
  30
  31 Everything below this line needs rework
  32 ---------------------------------------
  33
  34 Overview:
  35
  36 :`<uploaddocutils.sh>`_: Upload files to http://docutils.sf.net/tmp/
  37     using ``scp``, inserting the current date in the file name.
  38
  39 :`<update-htmlfiles>`_: Used to initialise a docutils-update upload directory.
  40     Generating html-files from txt-files first time.
  41
  42 :`<htmlfiles.lst>`_: The list of files for ``update-htmlfiles``.
  43
  44 and are these used by anyone.
  45
  46 :`<dbackport.sh>`_: Back-port changes from the trunk to the
  47     maintenance branch.
  48
  49 :`<fsfsbackup.sh>`_: Backup (mirror) an FSFS Subversion repository via
  50     SSH.  Used to backup the `Docutils Subversion repository`_.
  51
  52 .. _Docutils: http://docutils.sourceforge.net/
  53 .. _Docutils check-in mailing list:
  54    http://docutils.sf.net/docs/user/mailing-lists.html#docutils-checkins
  55 .. _web site: http://docutils.sourceforge.net/docs/dev/website.html
  56 .. _Docutils Subversion repository:
  57    http://docutils.sourceforge.net/docs/dev/repository.html
  58 .. _release.txt: http://docutils.sourceforge.net/docs/dev/release.html