1                  Working with the the wxWidgets release system
2                    =====================================
3
4Currently, to generate the release tarballs, wxWidgets uses a script which 
5reads from a series of manifest files to determine which files should be
6installed for a particular port. This document explains how to alter the list 
7of files that are distributed in the release tarballs.
8
9The scripts are located in the <wxWidgets root>/distrib/scripts folder, with 
10create_archives.sh doing most of the work to create the actual tarballs. 
11pre-flight.sh runs the entire process of doing a checkout, building the releases, 
12and putting them into the <wxWidgets root>/deliver folder. The manifest files
13are located in the <wxWidgets root>/distrib/scripts/manifests folder and
14they have a .rsp extension for historical reasons.
15
16
17Adding/removing a file from releases
18------------------------------------
19
20First, you must decide which tarballs you'd like to make the change to, in 
21order to determine which manifest file(s) the file should appear in.
22
23Below is a list of each port and the primary manifest files that are used to 
24generate that release. The "ALL" in the list is not for wxALL, it means that
25those manifests are where things that go in all ports should be.
26
27tarball     primary manifests
28-------     ----------------
29ALL         generic.rsp
30wxBase      base.rsp
31wxMSW       msw.rsp, wince.rsp
32wxOS2       os2.rsp
33wxGTK       gtk.rsp
34wxMAC       mac.rsp cocoa.rsp
35wxMotif     motif.rsp
36wxMGL       mgl.rsp
37wxX11       x11.rsp
38       
39Once you've decided which manifest file is most appropriate to add your file
40in, then open that manifest and add a line with your file(s) at the bottom.
41The file(s) should give the path relative to the wxWidgets root directory,
42like so:
43
44docs/tech/tn0033.txt
45
46At the current time, wildcards in filenames are also accepted. Once the files are
47added, they should show up in releases when distrib/scripts/pre-flight.sh is run.
48
49
50