sandbox/infrastructure/README.txt

   1 ==========================
   2  Docutils_ Infrastructure
   3 ==========================
   4
   5 :Author: Lea Wiemann
   6 :Contact: LeWiemann@gmail.com
   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 TODOs:
  16
  17 * subversion is now on sourceforge
  18   - change release and update
  19
  20 * sourceforge does not have cron, but berlios installation
  21   did not work since long time.
  22
  23 * clean up.
  24
  25 Overview:
  26
  27 :`<commit-email>`_: A patch to commit-email.pl used for the `Docutils
  28     check-in mailing list`_.
  29
  30 :`<dbackport.sh>`_: Back-port changes from the trunk to the
  31     maintenance branch.
  32
  33 :`<docutils-update>`_: The script that updates the `web site`_.
  34     Executed on berlios, by user wiemann.
  35
  36     Attention: The cron job is executed, but the script is
  37         doing nothing, because of the way to access sourceforge
  38         changed.
  39
  40 :`<docutils-update.local>`_: The script to update the `web site`_
  41     from a developer machine. *The* current way of to go.
  42
  43 :`<fsfsbackup.sh>`_: Backup (mirror) an FSFS Subversion repository via
  44     SSH.  Used to backup the `Docutils Subversion repository`_.
  45
  46 :`<release.sh>`_: The script to make releases_ of Docutils.
  47
  48 :`<uploaddocutils.sh>`_: Upload files to http://docutils.sf.net/tmp/
  49     using ``scp``, inserting the current date in the file name.
  50
  51 :`<update-htmlfiles>`_: Used to initialise a docutils-update upload directory.
  52     Generating html-files from txt-files first time.
  53
  54 :`<htmlfiles.lst>`_: The list of files for ``update-htmlfiles``.
  55
  56 .. _Docutils: http://docutils.sourceforge.net/
  57 .. _Docutils check-in mailing list:
  58    http://docutils.sf.net/docs/user/mailing-lists.html#docutils-checkins
  59 .. _web site: http://docutils.sourceforge.net/docs/dev/website.html
  60 .. _Docutils Subversion repository:
  61    http://docutils.sourceforge.net/docs/dev/repository.html
  62 .. _releases: http://docutils.sourceforge.net/docs/dev/release.html