forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r357259 - /forrest/trunk/site-author/content/xdocs/contrib.xml
Date Sat, 17 Dec 2005 00:16:02 GMT
Author: crossley
Date: Fri Dec 16 16:15:55 2005
New Revision: 357259

Update the notes on patch submission.
Techniques suggested by Richard Calmbach and Ross Gardler.


Modified: forrest/trunk/site-author/content/xdocs/contrib.xml
--- forrest/trunk/site-author/content/xdocs/contrib.xml (original)
+++ forrest/trunk/site-author/content/xdocs/contrib.xml Fri Dec 16 16:15:55 2005
@@ -178,21 +178,35 @@
     <section id="patch">
      <title>How to prepare and contribute patches</title>
-     <p>If you use the current development version of Forrest, then do
+     <p>If you use the current development version of Forrest via Subversion,
+       then do
        '<code>svn update; svn status</code>' to see what files that you
        have changed.
        Do '<code>svn diff > mypatch.txt</code>' to make a patch which
        includes every change. To make a patch for a specific file, do
        <code>svn diff src/documentation/content/xdocs/faq.xml > faq.xml.diff</code>'.
+       It is better to prepare the patch from the $FORREST_HOME directory
+       so that it contains a definite path to the document. However, be careful
+       that the patch does not contain other work-in-progress.
+     </p>
+     <p>
        For more information about working with SVN, see
        <link href="">Version Control with
        Subversion</link> - the opensource SVN book.
-      </p>
-      <p>If you use a downloaded released version of Forrest, then do
-        '<code>diff -u faq.xml.orig faq.xml > faq.xml.diff</code>'
+     </p>
+     <p>
+       If you use a downloaded released version of Forrest (or don't use SVN),
+       then use the 'diff' command of your operating system:
+        '<code>diff -u faq.xml.orig faq.xml > mypatch.txt</code>' (better
+       to do that from $FORREST_HOME directory). If you want to use the most
+       recent version of the documentation then grab its source file directly
+       from the
+       <link href="">SVN
+       (and tell us which Revision number you used).
       <note>Please send all contributions via our
         <link href="site:bugs">issue tracker</link>.
+       and specify the Forrest version or svn version of the source.
         It is always a good idea to check the Forrest

View raw message