escape underscores to fix the docs build

[wxWidgets.git] / docs / tech / tn0013.txt

diff --git a/docs/tech/tn0013.txt b/docs/tech/tn0013.txt
index 88b46cd3a067b9e667d84c2a2a2b972b822ca640..6b170e754a51b5a67b08827446d1ec9cf99d164e 100644 (file)
--- a/docs/tech/tn0013.txt
+++ b/docs/tech/tn0013.txt
@@ -8,26 +8,31 @@ This note explains what should be done, step by step, to prepare the packages
 for a wxGTK distribution. Note that the same instructions should be used for
 the other Unix-based ports including wxMotif, wxX11 and wxBase.
 
 for a wxGTK distribution. Note that the same instructions should be used for
 the other Unix-based ports including wxMotif, wxX11 and wxBase.
 

+See distrib/msw/makerpm for a script that embodies some of the steps
+below.
+

 1. Preparing the sources
 ------------------------
 
 a) Do a fresh checkout using the command
 
 1. Preparing the sources
 ------------------------
 
 a) Do a fresh checkout using the command
 

-        cvs -d :pserver:anoncvs@cvs.wxwindows.org:/packs/cvsroots/wxwindows co wxGTK
+   cvs -d :pserver:anoncvs@cvs.wxwidgets.org:/packs/cvsroots/wxwidgets co wxGTK

 
    NB: if you realize later that some needed files were not checked out
        by this command, please modify CVSROOT/modules to include the missing
        files so that it works for the next release!
 
    You also need the samples, demos and contrib directories, so change to
 
    NB: if you realize later that some needed files were not checked out
        by this command, please modify CVSROOT/modules to include the missing
        files so that it works for the next release!
 
    You also need the samples, demos and contrib directories, so change to

-   wxWindows directory created by the first cvs command and do "cvs up -d"
-   for each of them.
+   wxWidgets directory created by the first cvs command and do "cvs up -d"
+   for each of them. Of course, you can also check out everything (use
+   wxWidgets module name instead of wxGTK) if the bandwidth and disk space
+   are not a problem.

 
 

-b) Create a build directory under wxWindows, e.g. I use "gtk-release",
+b) Create a build directory under wxWidgets, e.g. I use "gtk-release",

    "cd" to it and run configure: the options don't really matter, you can use
    something like
 
    "cd" to it and run configure: the options don't really matter, you can use
    something like
 

-       ../configure --no-recursion
+       ../configure -C --without-subdirs

 
    to make it run a bit faster.
 
 
    to make it run a bit faster.
 


@@ -88,16 +93,12 @@ b) Start RPM build by going to RPM_ROOT directory and typing "rpm -ba
    you'll have to restart from the very beginning because rpm doesn't allow
    to short circuit the package generation).
 
    you'll have to restart from the very beginning because rpm doesn't allow
    to short circuit the package generation).
 

-   If everything goes well, the following files are produced:
-
-   SRPMS/wxGTK-${version}-1.src.rpm
-   RPMS/i386/wxGTK-${version}-1.i386.rpm
-   RPMS/i386/wxGTK-devel-${version}-1.i386.rpm
-   RPMS/i386/wxGTK-gl-${version}-1.i386.rpm
-   RPMS/i386/wxGTK-static-${version}-1.i386.rpm
+   If everything goes well, this should produce many files in SRPMS and
+   RPMS/i386 subdirectories.

 
    Use "rpm -ba --with gtk2" to build GTK+2 version of wxGTK and use
 
    Use "rpm -ba --with gtk2" to build GTK+2 version of wxGTK and use

-   "rpm -ba --with gtk2 --with unicode" to build GTK+2 Unicode build.
+   "rpm -ba --with gtk2 --with unicode" to build GTK+2 Unicode build
+   (these are defaults, you can use --without option to change this).

 
    Note: you may want to set the environment variable SMP to 3 or 4 on an
          SMP machine to speed up the build (it uses "make -j$SMP" if the
 
    Note: you may want to set the environment variable SMP to 3 or 4 on an
          SMP machine to speed up the build (it uses "make -j$SMP" if the


@@ -110,12 +111,13 @@ c) Test the resulting RPMs: install them using "rpm -i" (or "rpm -U) as usual
 3. Building the DEBs
 --------------------
 
 3. Building the DEBs
 --------------------
 

-[Ron is doing this]
+This is explained in more details in debian/README.HowToBuild.txt.
+

 
 4. Uploading the files
 ----------------------
 
 
 4. Uploading the files
 ----------------------
 

-All 11 files should be uploaded (via FTP) to several locations.
+All files should be uploaded (via FTP) to several locations.

 
 a) incoming.sourceforge.net, go to project admin page on sf.net and choose
    add/edit releases for more details
 
 a) incoming.sourceforge.net, go to project admin page on sf.net and choose
    add/edit releases for more details


@@ -125,37 +127,34 @@ b) ftp://biolpc22.york.ac.uk/pub (Julian has the password)
 5. Announcing the release
 -------------------------
 
 5. Announcing the release
 -------------------------
 

-a) FreshMeat:
-   - http://freshmeat.net/projects/wxwindowsgtk/
-   - username and password are "wxgtk" for logging in
++ update www.wxwidgets.org
+
++ FreshMeat:
+   - http://freshmeat.net/projects/wxwidgets/

    - hit "new release" at the top
    - follow the step by step
 
    - hit "new release" at the top
    - follow the step by step
 

-b) wx-announce mailing list: mailto:wx-announce@lists.wxwindows.org
-
-   [where is the announcement text? TODO]
++ wx-announce mailing list: mailto:wx-announce@lists.wxwidgets.org

 
 

-c) update www.wxwindows.org
+   The standard announcement text is in docs/publicity/announce.txt

 
 

-d) GNOME (very effective, stays on front page for days):
-    - http://www.gnome.org/applist
-    - Search for wxWindows
-    - Update the version number
-    - Ignore the error message
++ GnomeFiles:
+   - http://www.gnomefiles.org/app.php/wxWidgets
+     (only for stable releases, probably need Robert's account)

 
 

-e) MacNN:
++ MacNN:

    - http://www.macnn.com
    - Contact or Contribute or something
 
    - http://www.macnn.com
    - Contact or Contribute or something
 

-f) MacRumors:
++ MacRumors:

    - http://www.macrumors.com
    - Contact or Contribute or something
 
    - http://www.macrumors.com
    - Contact or Contribute or something
 

-g) Apple Developers Connection:
++ Apple Developers Connection:

     mailto: adcnews@apple.com
 
     mailto: adcnews@apple.com
 

-h) LinuxDevices.com:
++ LinuxDevices.com:

     Interesting for wxUniversal.
 
     Interesting for wxUniversal.
 

-i) The Python mailing list:
++ The Python mailing list: