SF.net SVN: geany: [1481] trunk

[ntrel at users.sourceforge.net]

Revision: 1481
          http://svn.sourceforge.net/geany/?rev=1481&view=rev
Author:   ntrel
Date:     2007-04-27 08:10:25 -0700 (Fri, 27 Apr 2007)

Log Message:
-----------
Update Global Tags section now all filetypes can be generated.
Comment out 'should be written' from Preferences section.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/geany.docbook

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2007-04-27 11:00:29 UTC (rev 1480)
+++ trunk/ChangeLog	2007-04-27 15:10:25 UTC (rev 1481)
@@ -7,6 +7,9 @@
    tagmanager/include/tm_workspace.h:
    Add support for generating global tags files for non-C-like
    filetypes.
+ * doc/geany.docbook:
+   Update Global Tags section now all filetypes can be generated.
+   Comment out 'should be written' from Preferences section.
 
 
 2007-04-25  Nick Treleaven  <nick.treleaven at btinternet.com>

Modified: trunk/doc/geany.docbook
===================================================================
--- trunk/doc/geany.docbook	2007-04-27 11:00:29 UTC (rev 1480)
+++ trunk/doc/geany.docbook	2007-04-27 15:10:25 UTC (rev 1481)
@@ -955,7 +955,7 @@
 				See <xref linkend="search_gototag"/>.
 			</para>
 			</section>
-			<section><title>Global tags</title>
+			<section id="tags_global"><title>Global tags</title>
 			<para>
 				Global tags are used to provide autocompletion and calltips without having to open
 				the corresponding source files. This is intended for library APIs, as the tags file
@@ -982,7 +982,8 @@
 					<listitem><para>C - GTK+ and GLib</para></listitem>
 					<listitem><para>Pascal</para></listitem>
 					<listitem><para>PHP</para></listitem>
-					<listitem><para>HTML - ampersand, copyright, etc. symbol completion</para></listitem>
+					<listitem><para>HTML - <literal>&symbol;</literal> completion, e.g.
+					for ampersand, copyright, etc.</para></listitem>
 					<listitem><para>LaTeX</para></listitem>
 				</itemizedlist>
 			</para>
@@ -991,19 +992,13 @@
 			<para>
 				<note><title>Filetypes support</title>
 				<para>
-					Currently this is only supported for filetypes that can be pre-processed
-					with <filename>gcc</filename>,
-					i.e. do not use the <literal>#</literal> character outside of strings.
-					Also Pascal, PHP and LaTeX will not work yet.
+					Currently this is not yet supported for Pascal, PHP and LaTeX filetypes.
 				</para>
-				<para>
-					This is known to work with C, C++ and D filetypes.
-				</para>
 				</note>
 			</para>
 			<para>
 				You can generate your own global tags files by parsing a list of source files.
-				The format is:
+				The command is:
 			</para>
 			<para>
 				geany -g <Tag File> <File list>
@@ -1011,21 +1006,23 @@
 			<para>
 				<itemizedlist>
 					<listitem><para><emphasis>Tag File</emphasis> should be in the format described
-						earlier.</para></listitem>
+						earlier - see <xref linkend="tags_global"/>.</para></listitem>
 					<listitem><para><emphasis>File list</emphasis> is a list of filenames, each with
-						a full path.</para></listitem>
+						a full path (unless you are generating C/C++ tags and have set the CFLAGS
+						environment variable appropriately).</para></listitem>
 				</itemizedlist>
 			</para>
 			<para>
-				<filename>gcc</filename> is required, as C/C++ header files are preprocessed to include
-				any other header files they depend upon. Currently <filename>grep</filename> is
-				also required for tags generation.
-			</para>
-			<para>
 				Example for the wxD library for the D programming language:
 				<programlisting>geany -g wxd.d.tags /home/username/wxd/wx/*.d</programlisting>
 			</para>
+			<section><title>Generating C/C++ tag files</title>
 			<para>
+				For C/C++ tag files, <filename>gcc</filename> and <filename>grep</filename> are
+				required, so that header files can be preprocessed to include
+				any other headers they depend upon.
+			</para>
+			<para>
 				For C/C++ files, the environment variable CFLAGS should be set with appropriate
 				<literal>-I/path</literal> include paths.
 				The following example works with the <filename>bash</filename> shell, generating
@@ -1050,15 +1047,18 @@
 				tags file because it will get overwritten when upgrading
 				<application>Geany</application>.
 				</para>
+				<para>This is a temporary solution - in later versions this will be unnecessary.
+				</para>
 				</note>
 			</para>
-			</section>
-			</section>
+			</section><!-- C/C++ -->
+			</section><!-- Generating -->
+			</section><!-- Tags -->
 		</section>
 		<section id="confdialog">
 			<title>Preferences</title>
 			<para>
-				should be written
+				<!-- should be written -->
 				<!-- I know that <mediaobject> is better than <graphic> but <mediaobject> does not work with PDF -->
 				<figure id="confdialog_gen">
 				   <title>General tab in preferences dialog</title>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.