Fix wrong configure test for abi::__forced_unwind in previous commit.

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

diff --git a/docs/tech/tn0001.txt b/docs/tech/tn0001.txt
index 02015b478984e737c3e877eb1917b5fafafbdb2c..c08c11d0ac09b22e93785cec5df0ea276a90114a 100644 (file)
--- a/docs/tech/tn0001.txt
+++ b/docs/tech/tn0001.txt
@@ -1,13 +1,13 @@
-                    How to add a new sample to wxWindows.
+                    How to add a new sample to wxWidgets.

                     =====================================
 
 To add a new sample "foo" under directory "samples/foo" you need to do
 the following: (note that all this applies also to demos: just replace
 samples/ with demos/ where needed).
 
                     =====================================
 
 To add a new sample "foo" under directory "samples/foo" you need to do
 the following: (note that all this applies also to demos: just replace
 samples/ with demos/ where needed).
 

-1. Create the directory samples/foo locally and "cvs add" it.
+1. Create the directory samples/foo locally and "svn add" it.

 
 

-2. "cvs add" the sample sources (usually based on minimal.cpp) as well.
+2. "svn add" the sample sources (usually based on minimal.cpp) as well.

 
    Note that unless your sample requires something special you shouldn't
    add foo.rc, foo.ico, ... any more, please just reuse the generic sample.*
 
    Note that unless your sample requires something special you shouldn't
    add foo.rc, foo.ico, ... any more, please just reuse the generic sample.*


@@ -27,25 +27,32 @@ samples/ with demos/ where needed).
       You may also use "bakefile_gen -b ../../samples/foo/foo.bkl" to
       regenerate only the makefiles for this sample (path must be relative!)
       or even add a "-f<compiler>" to generate just the makefiles for the given
       You may also use "bakefile_gen -b ../../samples/foo/foo.bkl" to
       regenerate only the makefiles for this sample (path must be relative!)
       or even add a "-f<compiler>" to generate just the makefiles for the given

-      compiler (possible values are in FORMATS.bkmanifest file in bakefile
-      source tree)
+      compiler (run 'bakefile --help' to get the list of possible values).
+      See Technote #16 for more information.
+   d) currently samples/samples.dsw needs to be updated manually as it's not
+      generated by bakefile.

 
 

-4. Modify configure.in and samples/configure.in for Unix compilation:
+4. Modify configure.in Unix compilation:

    a) if the sample should only be built if "wxUSE_FOO" is enabled, locate
       the test for "wxUSE_FOO = yes" in configure.in and add a line
       SAMPLES_SUBDIRS="$SAMPLES_SUBDIRS foo" under it
    b) if it should be always built, locate the line "if test $wxUSE_GUI = yes"
       near the end of configure.in and modify the assignment to
       SAMPLES_SUBDIRS to include "foo" (put in alphabetical order)
    a) if the sample should only be built if "wxUSE_FOO" is enabled, locate
       the test for "wxUSE_FOO = yes" in configure.in and add a line
       SAMPLES_SUBDIRS="$SAMPLES_SUBDIRS foo" under it
    b) if it should be always built, locate the line "if test $wxUSE_GUI = yes"
       near the end of configure.in and modify the assignment to
       SAMPLES_SUBDIRS to include "foo" (put in alphabetical order)

-   c) add foo/Makefile to AC_OUTPUT in samples/configure.in

 
 

-   After this, regenerate configure and samples/configure from configure.in
+   After this, regenerate configure from configure.in

    by running "autoconf" on a Unix system in the corresponding directory.
 
 5. Add a short description of what the sample does and how does it work
    by running "autoconf" on a Unix system in the corresponding directory.
 
 5. Add a short description of what the sample does and how does it work

-   to the "samples overview" section in the wxWindows manual. That section
-   lives in docs/latex/wx/tsamples.tex; look at the descriptions for other
-   samples, if you are not familiar with LaTeX.
+   to the "samples overview" section in the wxWidgets manual. That section
+   lives in docs/doxygen/mainpages/samples.h; look at the descriptions for
+   other samples, if you are not familiar with Doxygen.
+
+6. Add any non-standard sample's files to build/bakefiles/make_dist.mk (the
+   makefiles copies all bmp, cpp, h, ico, png, rc, xpm and makefiles by
+   default, you only need to update it if the sample uses some other files)
+   and run the ./update-manifests.sh script in distrib/scripts (don't forget
+   to check the changes to manifests/*.rsp files in).

 
 === EOF ===
 
 
 === EOF ===