Add documentation for --no-preprocessing option.

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1918 ea778897-0a13-0410-b9d1-a72fbfd435f5

ChangeLog

@@ -7,6 +7,8 @@
  * src/main.c, src/symbols.c, src/symbols.h:
    Add --no-preprocessing, -P option when generating tags files to
    disable preprocessing of C/C++ source files.
+ * doc/geany.txt, doc/geany.html, doc/geany.1.in, NEWS:
+   Add documentation for --no-preprocessing option.
 
 
 2007-09-27  Enrico Tröger  <enrico(dot)troeger(at)uvena(dot)de>

NEWS

@@ -51,6 +51,8 @@ Geany 0.12 (TBA)
     * Added auto_complete_whilst_editing hidden preference.
     * Speed up Save All for C-like files.
     * Don't show file opened/saved/closed messages on the status bar.
+    * Added --no-preprocessing, -P option when generating tags files to
+      disable preprocessing of C/C++ source files.
     (Thanks also to Christoph Berg for updating the icon code).
 
     Docs:

doc/geany.1.in

@@ -23,7 +23,9 @@ Run Geany in debug mode, which means being verbose and printing lots of informat
 .IP "\fB\fP             \fB\-\-ft\-names\fP         " 10
 Print a list of Geany's internal filetype names (useful for the auto completion list).
 .IP "\fB-g\fP           \fB\-\-generate\-tags\fP         " 10
-Generate global tags file (see documentation).
+Generate a global tags file (see documentation).
+.IP "\fB-P\fP           \fB\-\-no\-preprocessing\fP         " 10
+Don't preprocess C/C++ files when generating tags.
 .IP "\fB-i\fP           \fB\-\-new-instance\fP         " 10
 Don't open files in a running instance, force opening a new instance.
 Only available if Geany was compiled with support for Sockets.

doc/geany.html

@@ -420,8 +420,8 @@ Return:</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="13%" />
-<col width="26%" />
+<col width="25%" />
-<col width="61%" />
+<col width="62%" />
 </colgroup>
 <thead valign="bottom">
 <tr><th class="head">Short option</th>
@@ -437,7 +437,7 @@ Return:</p>
 <tr><td>-c dir_name</td>
 <td>--config=directory_name</td>
 <td>Use an alternate configuration directory. Default
-configuration directory is ~/.geany/ and there resides
+configuration directory is <tt class="docutils literal"><span class="pre">~/.geany/</span></tt> and there resides
 <tt class="docutils literal"><span class="pre">geany.conf</span></tt> and other configuration files.</td>
 </tr>
 <tr><td>-d</td>
@@ -450,6 +450,15 @@ and printing lots of information.</td>
 <td>Print a list of Geany's internal filetype names (useful
 for the auto completion list).</td>
 </tr>
+<tr><td>-g</td>
+<td>--generate-tags</td>
+<td>Generate a global tags file (see
+<a class="reference" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
+</tr>
+<tr><td>-P</td>
+<td>--no-preprocessing</td>
+<td>Don't preprocess C/C++ files when generating tags.</td>
+</tr>
 <tr><td>-i</td>
 <td>--new-instance</td>
 <td>Do not open files in a running instance, force opening
@@ -482,7 +491,7 @@ option if you do not want to use them.</td>
 <td>--no-terminal</td>
 <td>Do not load terminal support. Use this option if you do
 not want to load the virtual terminal emulator widget
-at startup. If you do not have libvte.so.4 installed,
+at startup. If you do not have <tt class="docutils literal"><span class="pre">libvte.so.4</span></tt> installed,
 then terminal-support is automatically disabled. Only
 available if Geany was compiled with support for VTE.</td>
 </tr>
@@ -1150,7 +1159,7 @@ filetypes.</p>
 <p>You can generate your own global tags files by parsing a list of
 source files. The command is:</p>
 <pre class="literal-block">
-geany -g &lt;Tag File&gt; &lt;File list&gt;
+geany -g [-P] &lt;Tag File&gt; &lt;File list&gt;
 </pre>
 <ul class="simple">
 <li>Tag File should be in the format described earlier -- see the
@@ -1158,6 +1167,11 @@ section called <a class="reference" href="#global-tags">Global tags</a>.</li>
 <li>File list is a list of filenames, each with a full path (unless
 you are generating C/C++ tags and have set the CFLAGS environment
 variable appropriately).</li>
+<li><tt class="docutils literal"><span class="pre">-P</span></tt> or <tt class="docutils literal"><span class="pre">--no-preprocessing</span></tt> disables using the C pre-processor
+to process <tt class="docutils literal"><span class="pre">#include</span></tt> directives for C/C++ source files. Use this
+option if you want to specify each source file on the command-line
+instead of using a 'master' header file. Also can be useful if you
+don't want to specify the CFLAGS environment variable.</li>
 </ul>
 <p>Example for the wxD library for the D programming language:</p>
 <pre class="literal-block">
@@ -1183,8 +1197,6 @@ of header files. When Geany is next started, your custom tags file
 will be loaded instead of the default global.tags. You should keep a
 copy of the generated tags file because it will get overwritten when
 upgrading Geany.</p>
-<p>This is a temporary solution -- in later versions this will be
-unnecessary.</p>
 </div>
 </div>
 </div>
@@ -3066,7 +3078,7 @@ USE OR PERFORMANCE OF THIS SOFTWARE.</p>
 <div class="footer">
 <hr class="footer" />
 <a class="reference" href="geany.txt">View document source</a>.
-Generated on: 2007-09-13 16:43 UTC.
+Generated on: 2007-09-28 15:47 UTC.
 Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
 
 </div>

doc/geany.txt

@@ -180,7 +180,7 @@ Short option  Long option              Function
 *none*        --column                 Set initial column number for the first opened file.
 
 -c dir_name   --config=directory_name  Use an alternate configuration directory. Default
-                                       configuration directory is ~/.geany/ and there resides
+                                       configuration directory is ``~/.geany/`` and there resides
                                        ``geany.conf`` and other configuration files.
 
 -d            --debug                  Run Geany in debug mode, which means being verbose
@@ -189,6 +189,11 @@ Short option  Long option              Function
 *none*        --ft-names               Print a list of Geany's internal filetype names (useful
                                        for the auto completion list).
 
+-g            --generate-tags          Generate a global tags file (see
+                                       `Generating a global tags file`_).
+
+-P            --no-preprocessing       Don't preprocess C/C++ files when generating tags.
+
 -i            --new-instance           Do not open files in a running instance, force opening
                                        a new instance. Only available if Geany was compiled
                                        with support for Sockets.
@@ -207,7 +212,7 @@ Short option  Long option              Function
 
 -t            --no-terminal            Do not load terminal support. Use this option if you do
                                        not want to load the virtual terminal emulator widget
-                                       at startup. If you do not have libvte.so.4 installed,
+                                       at startup. If you do not have ``libvte.so.4`` installed,
                                        then terminal-support is automatically disabled. Only
                                        available if Geany was compiled with support for VTE.
 
@@ -952,13 +957,18 @@ filetypes.
 You can generate your own global tags files by parsing a list of
 source files. The command is::
 
-    geany -g <Tag File> <File list>
+    geany -g [-P] <Tag File> <File list>
 
 * Tag File should be in the format described earlier -- see the
   section called `Global tags`_.
 * File list is a list of filenames, each with a full path (unless
   you are generating C/C++ tags and have set the CFLAGS environment
   variable appropriately).
+* ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
+  to process ``#include`` directives for C/C++ source files. Use this
+  option if you want to specify each source file on the command-line
+  instead of using a 'master' header file. Also can be useful if you
+  don't want to specify the CFLAGS environment variable.
 
 Example for the wxD library for the D programming language::
 
@@ -991,9 +1001,6 @@ will be loaded instead of the default global.tags. You should keep a
 copy of the generated tags file because it will get overwritten when
 upgrading Geany.
 
-This is a temporary solution -- in later versions this will be
-unnecessary.
-
 
 
 Preferences