docs/tech/tn0022.txt

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