SF.net SVN: geany:[5618] trunk/doc

[colombanw at users.sourceforge.net]

Revision: 5618
          http://geany.svn.sourceforge.net/geany/?rev=5618&view=rev
Author:   colombanw
Date:     2011-03-23 22:36:56 +0000 (Wed, 23 Mar 2011)

Log Message:
-----------
Update the documentation to talk about real-time tag parsing

Modified Paths:
--------------
    trunk/doc/geany.html
    trunk/doc/geany.txt

Modified: trunk/doc/geany.html
===================================================================
--- trunk/doc/geany.html	2011-03-22 23:08:43 UTC (rev 5617)
+++ trunk/doc/geany.html	2011-03-23 22:36:56 UTC (rev 5618)
@@ -1909,10 +1909,12 @@
 tags files, as described below.</p>
 <div class="section" id="workspace-tags">
 <h3><a class="toc-backref" href="#id78">Workspace tags</a></h3>
-<p>Tags for each document are parsed whenever a file is loaded or
-saved. These are shown in the Symbol list in the Sidebar. These tags
-are also used for autocompletion of symbols and calltips for all documents
-open in the current session that have the same filetype.</p>
+<p>Tags for each document are parsed whenever a file is loaded or saved, and
+possibly when modified (see <em>Symbol list update frequency</em> preference in the
+<a class="reference internal" href="#editor-completions-preferences">Editor Completions preferences</a>). These are shown in the Symbol list in
+the Sidebar. These tags are also used for autocompletion of symbols and
+calltips for all documents open in the current session that have the same
+filetype.</p>
 <p>The <em>Go to Tag</em> commands can be used with all workspace tags. See
 <a class="reference internal" href="#go-to-tag-definition">Go to tag definition</a>.</p>
 </div>
@@ -2428,6 +2430,17 @@
 <dd>The number of rows to display for the autocompletion window.</dd>
 <dt>Max. symbol name suggestions</dt>
 <dd>The maximum number of items in the autocompletion list.</dd>
+<dt>Symbol list update frequency</dt>
+<dd><p class="first">The minimum delay (in milliseconds) between two symbol list updates.</p>
+<p>This option determines how frequently the tag list is updated for the
+current document. The smaller is the delay the more up-to-date is the
+symbol list (and then the completions); but rebuilding the symbol list
+has a cost in performance, especially with large files.</p>
+<p>The default value is 250, which means the symbol list will be updated at
+most 4 times per second, even if the document changes continuously.</p>
+<p class="last">A value of 0 disables automatic updates, so the symbol list will only be
+updated upon document saving.</p>
+</dd>
 </dl>
 </div>
 <div class="section" id="auto-close-quotes-and-brackets">
@@ -6471,7 +6484,7 @@
 <div class="footer">
 <hr class="footer" />
 <a class="reference external" href="geany.txt">View document source</a>.
-Generated on: 2011-03-20 14:49 UTC.
+Generated on: 2011-03-23 22:34 UTC.
 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
 
 </div>

Modified: trunk/doc/geany.txt
===================================================================
--- trunk/doc/geany.txt	2011-03-22 23:08:43 UTC (rev 5617)
+++ trunk/doc/geany.txt	2011-03-23 22:36:56 UTC (rev 5618)
@@ -1505,10 +1505,12 @@
 Workspace tags
 ^^^^^^^^^^^^^^
 
-Tags for each document are parsed whenever a file is loaded or
-saved. These are shown in the Symbol list in the Sidebar. These tags
-are also used for autocompletion of symbols and calltips for all documents
-open in the current session that have the same filetype.
+Tags for each document are parsed whenever a file is loaded or saved, and
+possibly when modified (see *Symbol list update frequency* preference in the
+`Editor Completions preferences`_). These are shown in the Symbol list in
+the Sidebar. These tags are also used for autocompletion of symbols and
+calltips for all documents open in the current session that have the same
+filetype.
 
 The *Go to Tag* commands can be used with all workspace tags. See
 `Go to tag definition`_.
@@ -2090,7 +2092,21 @@
 Max. symbol name suggestions
     The maximum number of items in the autocompletion list.
 
+Symbol list update frequency
+    The minimum delay (in milliseconds) between two symbol list updates.
 
+    This option determines how frequently the tag list is updated for the
+    current document. The smaller is the delay the more up-to-date is the
+    symbol list (and then the completions); but rebuilding the symbol list
+    has a cost in performance, especially with large files.
+
+    The default value is 250, which means the symbol list will be updated at
+    most 4 times per second, even if the document changes continuously.
+
+    A value of 0 disables automatic updates, so the symbol list will only be
+    updated upon document saving.
+
+
 Auto-close quotes and brackets
 ``````````````````````````````
 


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