Release 1.4.6

[cygwin-apps/cygutils.git] / HOW-TO-CONTRIBUTE

diff --git a/HOW-TO-CONTRIBUTE b/HOW-TO-CONTRIBUTE
index 22d7b0792d872f569190d9d3d42b1e5761b0e402..5bae9693fb7fb548b6a408a189a97628c66ef53b 100644 (file)
--- a/HOW-TO-CONTRIBUTE
+++ b/HOW-TO-CONTRIBUTE
@@ -79,6 +79,11 @@ The simple 12 step program:
       the blurb in the .c or .h file is just that: a short
       blurb, with a reference to the full text elsewhere)
 
+      You should also add it to the licenses variable in 
+      the toplevel Makefile.am: e.g.
+
+      licenses = ... licenses/COPYING.MPL ...
+
 3) Make a home 
 
    create a new directory for your contribution underneath 'src'
@@ -162,10 +167,11 @@ The simple 12 step program:
      The configuration process will replace @LIBINTL@ with the 
      appropriate -lintl -liconv invocation.
 
-     Note that you do NOT need to include the following libraries in
-     a 'src_foo_foo_LDADD' line; these will be added automatically...
+     Note that you do NOT need to include the popt library in
+     a 'src_foo_foo_LDADD' line; -lpopt will be added automatically...
 
-     -lcygipc -lpopt  (that is, cygipc or popt)
+     If your app depends on IPC functions, then add @IPCLIBS@ 
+     to the 'src_foo_foo_LDADD' line.
 
   c) man pages and other documentation
 
@@ -174,13 +180,20 @@ The simple 12 step program:
 
      man_MANS = ... src/foo/foo.1 ...
 
-     If there are non-man-page documentation files, you should those
-     files to the EXTRA_DIST variable:
-
-     EXTRA_DIST = ... src/foo/foo.README ...
-
-     However, there is no provisiion for actually INSTALLING these
-     additional documentation files.  At least not yet.
+     If there are non-man-page documentation files, you should do 
+     one of the following:
+       i) if your app is windows-specific, then create a new
+          variable inside the 'if WITH_WINDOWS_PROGRAMS' section 
+          suffixed with '_docs', and list the documentation files
+             foo_docs = src/foo/README src/foo/TODO
+          Also, add those files to the extra_docs variable (which
+          gets automatically included in EXTRA_DIST)
+             extra_docs = src/foo/README src/foo/TODO
+      ii) otherwise, simply create the 'foo_docs' variable
+          outside of the 'if WITH_WINDOWS_PROGRAMS' section
+     These files will be installed into $(docdir)/foo/ so there
+     is no worry that your README will conflict with any other
+     component's README.
 
   d) Extra files
 
@@ -205,6 +218,10 @@ The simple 12 step program:
   follow the "patterns" established in it by the other programs, 
   or (gasp) read the automake documentation.
 
+  Libraries are quite complicated to deal with in the cygutils 
+  build framework. Fortunately I doubt there will be many of
+  these to worry about, other than cygicons.
+
 6) Simplify your #includes.
 
    Take a good look at the #include statements in your .c and .h
@@ -222,7 +239,8 @@ The simple 12 step program:
 
    Add a short blurb about your app to <cygutils>/PROGLIST
    Add your app to the list at the end of the README file
-   Add your name to the AUTHORS file.
+   Add your name to the AUTHORS file.  Don't worry about NEWS;
+   I do that before each release.
 
 8) Bootstrap
 
@@ -292,7 +310,7 @@ The simple 12 step program:
    the ChangeLog into that notice.  But do NOT send the patch or 
    tarball to the mailing list.  
        
-   Instead, send that to ME, cwilson@ece.gatech.edu.  The patch
+   Instead, send that to ME, cygwin@cwilson.fastmail.fm.  The patch
    and tarball should be attachments, but paste the ChangeLog entry
        into the body of the message.  Do NOT paste your patch into the 
        body of the email; most mail programs will horrendously distort