fix typo; wrap lines; add some clarifications
[wxWidgets.git] / docs / tech / tn0022.txt
1                    Working with the wxWidgets release system
2                    =========================================
3
4 Process Overview:
5 - run build/tools/create-archive.py --compression=all /path/to/output/dir
6 - upload release to sf.net
7 - update wxwidgets.org
8 - promote release on software download sites
9
10
11 Currently our release system uses a Python 2.x script to generate releases.
12 The script requires Unix utilities such as tar, zip and unix2dos and thus must
13 be run either on Unix or using Cygwin on Windows. To generate a release, simply
14 run the following command:
15
16 build/tools/create-archive.py --compression=all /path/to/output/dir
17
18 This will produce zip, gzip and bzip archives of the tree (without
19 "compression" argument only .gz is made). Note that this commands produces huge
20 amounts of output so redirecting it to a file is recommended.
21
22 To add a prefix to the release, such as RC1, the SVN revision, or a date, just
23 pass --postfix="postfix" to the script. More info on the options and their
24 possible values can be found by calling `create-archive.py --help`.
25
26 IMPORTANT NOTE: You *must* run this script from a clean source tree, that is,
27           with no junk files in it or modifications. This is because the
28           release should be a pristine copy of the tree as of the time of
29           release. If you have legitimate modifications in the tree that need
30           to be in the release, commit them first.
31