Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Git mirror of the shFlags project by Kate Ward
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


shFlags 1.0.x README

This project is stored on as
Documentation is available there, as are all releases and source code. The
source code is stored in Subversion and can be accessed using the following

Check out the code locally ::

  $ svn checkout shflags-read-only

Browse the code in a web browser:

- svn > trunk > source > 1.0

Making a release

For these steps, it is assumed we are working with release 1.0.0.


- write release notes
- update version
- finish changelog
- check all the code in
- tag the release
- export the release
- create tarball
- md5sum the tarball and sign with gpg
- update website
- post to and Freshmeat

Write Release Notes

This should be pretty self explainatory. Use one of the release notes from a
previous release as an example.

To get the versions of the various shells, run the `bin/`
command. ::

  $ bin/
  os:Mac OS X version:10.5.3
  shell:/bin/bash version:3.2.17(1)-release
  shell:/bin/dash version:not_installed
  shell:/bin/ksh version:M-1993-12-28
  shell:/bin/pdksh version:not_installed
  shell:/bin/zsh version:4.3.4

Update Version

Edit ``src/shflags`` and change the version number in the ``__FLAGS_VERSION``
variable. Next, edit the ``src/docbook/shflags.xml`` file, edit the version in
the ``<title>`` element, and make sure there is a revision section for this

Finish Documentation

Make sure that any remaning changes get put into the ``CHANGES-X.X.txt`` file.

Finish writing the ``RELEASE_NOTES-X.X.X.txt``. Once it is finished, run it
through the **fmt** command to make it pretty. ::

  $ fmt -w 80 RELEASE_NOTES-2.0.0.txt >
  $ mv RELEASE_NOTES-2.0.0.txt

We want to have an up-to-date version of the documentation in the release, so
we'd better build it. ::

  $ pwd
  $ make docs
  $ cp -p build/shunit2.html doc
  $ rst2html --stylesheet-path=share/css/rst2html.css doc/README.txt >doc/README.html

Check In All the Code

This step is pretty self-explainatory ::

  $ pwd
  $ svn ci -m "finalizing release"

Tag the Release

  $ pwd
  $ ls
  2.0  2.1
  $ svn cp -m "Release 2.0.0" 2.0

Export the Release

  $ pwd
  $ svn export shunit2-2.0.0

Create Tarball

  $ tar cfz ../releases/shunit2-2.0.0.tgz shunit2-2.0.0

md5sum the Tarball and Sign With gpg

  $ cd ../releases
  $ md5sum shunit2-2.0.0.tgz >shunit2-2.0.0.tgz.md5
  $ gpg --default-key --detach-sign shunit2-2.0.0.tgz

Update Website

Again, pretty self-explainatory. Make sure to copy the MD5 and GPG signature
files. Once that is done, make sure to tag the website so we can go back in
time if needed. ::

  $ pwd
  $ ls
  source  website
  $ svn cp -m "Release 2.0.0" \

Now, update the website. It too is held in Subversion, so **ssh** into
SourceForge and use ``svn up`` to grab the latest version.

Post to SourceForge and Freshmeat


Related Documentation

:Docbook XML:
:Docbook XSL:

.. generate HTML using rst2html from Docutils of
.. vim:syntax=rst:textwidth=80
.. $Revision$
Something went wrong with that request. Please try again.