Added tech notes on contributing and on making RPMs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7211 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
@@ -2,5 +2,7 @@ TN0001 How to add a new sample
|
|||||||
TN0002 wxWindows translator guide
|
TN0002 wxWindows translator guide
|
||||||
TN0003 Adding wxWindows class documentation
|
TN0003 Adding wxWindows class documentation
|
||||||
TN0004 Compiling a sample in the C++Builder 1.0 IDE
|
TN0004 Compiling a sample in the C++Builder 1.0 IDE
|
||||||
|
TN0005 Adding a wxWindows contribution
|
||||||
|
TN0006 Making and installing RPMs for wxWindows
|
||||||
|
|
||||||
Version: $Id$
|
Version: $Id$
|
||||||
|
|||||||
66
docs/tech/tn0005.txt
Normal file
66
docs/tech/tn0005.txt
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
Adding a wxWindows contribution
|
||||||
|
===============================
|
||||||
|
|
||||||
|
Here are some different kinds of contribution:
|
||||||
|
|
||||||
|
1. Bug fixes. You can send these to the wx-devel list.
|
||||||
|
2. New classes. New classes normally go in the contrib hierarchy:
|
||||||
|
please see below for more details. They may be promoted to
|
||||||
|
the main wxWindows hierarchy if they are deemed to be 'core'.
|
||||||
|
3. A utility application, such as a new dialog editor or
|
||||||
|
file format conversion utility. If adding to the CVS
|
||||||
|
archive, you may put it under the utils hierarchy,
|
||||||
|
preferably with further src and docs directories.
|
||||||
|
|
||||||
|
You may or may not wish to add your code to the main wxWindows CVS
|
||||||
|
archive. Whether your code is appropriate for this archive
|
||||||
|
should first be ascertained by discussing it on wx-devel@wxwindows.org.
|
||||||
|
|
||||||
|
The contrib hierarchy
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
When contributing a new class or set of classes, please
|
||||||
|
organise your files in the following hierarchy, so that
|
||||||
|
when a user unarchives your contribution, it
|
||||||
|
slots neatly into the existing source hierarchy.
|
||||||
|
It also simplifies compilation for users, since wxWindows
|
||||||
|
makefiles and project files are set up to search in
|
||||||
|
contrib/include/wx and contrib/lib. For example, to
|
||||||
|
include yourclass.h, the following directive is used:
|
||||||
|
|
||||||
|
#include "wx/yourclass/yourclass.h"
|
||||||
|
|
||||||
|
Here are the directories:
|
||||||
|
|
||||||
|
contrib/include/wx/yourclass/ ; Your header(s) go here
|
||||||
|
contrib/src/yourclass/ ; Your source file(s) go here
|
||||||
|
contrib/samples/yourclass/ ; Your sample(s) go here
|
||||||
|
contrib/docs/latex/yourclass/ ; Your Latex doc sources go here
|
||||||
|
contrib/docs/html/yourclass/ ; Your HTML doc files go here
|
||||||
|
contrib/docs/htmlhelp/yourclass/ ; Your MS HTML Help doc files go here
|
||||||
|
contrib/docs/htb/yourclass/ ; Your wxHTML doc files go here
|
||||||
|
contrib/docs/pdf/yourclass/ ; Your PDF doc files go here
|
||||||
|
contrib/docs/winhelp/yourclass/ ; Your WinHelp doc files go here
|
||||||
|
|
||||||
|
It is recommended that you produce a manual using Tex2RTF, as specified
|
||||||
|
in Technical Note TN0003. This allows you to output all the above
|
||||||
|
formats, though for PDF you will need Latex and Ghostscript or
|
||||||
|
Word and Adobe Acrobat, and for MS HTML Help and WinHelp you need
|
||||||
|
the appropriate (freely available) help compilers.
|
||||||
|
|
||||||
|
Your binary library files can go in the main lib directory or contrib/lib,
|
||||||
|
but the main lib directory is recommended.
|
||||||
|
|
||||||
|
Please include a readme.txt in your source directory, and conform
|
||||||
|
as much as possible to the coding guidelines specified on the web
|
||||||
|
site in the 'Backroom' section. Include as many makefiles as
|
||||||
|
possible for different compilers.
|
||||||
|
|
||||||
|
Your archive can be in .tgz or .zip format. For inclusion on
|
||||||
|
the wxWindows ftp site and CD-ROM, please send your submission to
|
||||||
|
Julian Smart <julian@wxwindows.org> as a binary attachment.
|
||||||
|
An entry will be added to the Contributions web page.
|
||||||
|
|
||||||
|
Author: Julian Smart
|
||||||
|
Version: $Id$
|
||||||
|
|
||||||
41
docs/tech/tn0006.txt
Normal file
41
docs/tech/tn0006.txt
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
How to make RPMs of the wxWindows sources
|
||||||
|
=========================================
|
||||||
|
|
||||||
|
This is just a short description. It is assumed that you know what you are
|
||||||
|
doing. I do not take any responsibility for damaged systems, use at your own
|
||||||
|
risk!
|
||||||
|
|
||||||
|
1. Extract the archive in a temporary directory. Since you are
|
||||||
|
reading this text, you already have done this.
|
||||||
|
2. Copy the .spec file to
|
||||||
|
(rpm-dir)/SPECS
|
||||||
|
3. Copy the .tgz file to
|
||||||
|
(rpm-dir)/SOURCES
|
||||||
|
4. Start the RPM manager with
|
||||||
|
rpm -bb (rpm-dir)/SPECS/(.spec-file)
|
||||||
|
or with
|
||||||
|
rpm -ba (rpm-dir)/SPECS/(.spec-file)
|
||||||
|
(the latter also builds the .src.rpm-file)
|
||||||
|
5. You now have a nice set of RPMs in (rpm-dir)/RPMS
|
||||||
|
|
||||||
|
Example
|
||||||
|
=======
|
||||||
|
|
||||||
|
Here's how to install e.g. wxMotif 2.1.14:
|
||||||
|
|
||||||
|
cp wxMotif.spec /usr/src/packages/SPECS
|
||||||
|
cp wxMotif-2.1.14.tgz /usr/src/packages/SOURCES
|
||||||
|
rpm -bb /usr/src/packages/SPECS/wxMotif.spec
|
||||||
|
|
||||||
|
Install the resulting packages with
|
||||||
|
|
||||||
|
rpm --install /usr/src/packages/RPMS/i386/wxMotif-2.1.14-0.i386.rpm
|
||||||
|
rpm --install /usr/src/packages/RPMS/i386/wxMotif-devel-2.1.14-0.i386.rpm
|
||||||
|
rpm --install /usr/src/packages/RPMS/i386/wxMotif-gl-2.1.14-0.i386.rpm
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
That's all. You should now have a working wxWindows library.
|
||||||
|
|
||||||
|
Regards,
|
||||||
|
Robert Fendt
|
||||||
Reference in New Issue
Block a user