Menu
▾
▴
[Tora-cvs] SF.net SVN: tora:[3372] trunk/tora/doc/help
|
From: <tom...@us...> - 2010-01-02 11:27:05
|
Revision: 3372
http://tora.svn.sourceforge.net/tora/?rev=3372&view=rev
Author: tomasstraupis
Date: 2010-01-02 11:26:54 +0000 (Sat, 02 Jan 2010)
Log Message:
-----------
Add some documentation on static check.
Modified Paths:
--------------
trunk/tora/doc/help/editor.html
trunk/tora/doc/help/editor.texi
trunk/tora/doc/help/plsqleditor.html
trunk/tora/doc/help/plsqleditor.texi
Modified: trunk/tora/doc/help/editor.html
===================================================================
--- trunk/tora/doc/help/editor.html 2009-12-30 21:53:43 UTC (rev 3371)
+++ trunk/tora/doc/help/editor.html 2010-01-02 11:26:54 UTC (rev 3372)
@@ -71,8 +71,11 @@
<br><dt><strong>Filename extensions</strong><dd> TODO.
<br><dt><strong>Tab stop width</strong><dd> TODO.
<br><dt><strong>Use only spaces when indenting</strong><dd> TODO.
-</dl>
- There may also be pages under this for each individual database provider. Currently onlye Oracle uses this feature. That setup looks like this.
+<br><dt><strong>Static checker</strong><dd> Specifies static checker to be used. This configuration option should contain %1 which will be replaced with a filename (with full path) containing code to be checked.
+ <pre class="example"> perl /usr/bin/staticChecker.pl --output=TORA --file=%1
+</pre>
+ </dl>
+ There may also be pages under this for each individual database provider. Currently only Oracle uses this feature. That setup looks like this.
</body></html>
Modified: trunk/tora/doc/help/editor.texi
===================================================================
--- trunk/tora/doc/help/editor.texi 2009-12-30 21:53:43 UTC (rev 3371)
+++ trunk/tora/doc/help/editor.texi 2010-01-02 11:26:54 UTC (rev 3372)
@@ -51,5 +51,10 @@
TODO.
@item @strong{Use only spaces when indenting}
TODO.
+@item @strong{Static checker}
+ Specifies static checker to be used. This configuration option should contain %1 which will be replaced with a filename (with full path) containing code to be checked.
+ @example
+perl /usr/bin/staticChecker.pl --output=TORA --file=%1
+ @end example
@end table
-There may also be pages under this for each individual database provider. Currently onlye Oracle uses this feature. That setup looks like this.
+There may also be pages under this for each individual database provider. Currently only Oracle uses this feature. That setup looks like this.
Modified: trunk/tora/doc/help/plsqleditor.html
===================================================================
--- trunk/tora/doc/help/plsqleditor.html 2009-12-30 21:53:43 UTC (rev 3371)
+++ trunk/tora/doc/help/plsqleditor.html 2010-01-02 11:26:54 UTC (rev 3372)
@@ -73,11 +73,25 @@
<br><dt><strong>Compile</strong><dd> Compile the current editor. This will compile the procedure with the debug option,
if you don't have the debug options you need to recompile it in order to be able to see watches. The keyboard shortcut for this is <strong>F9</strong>.
<br><dt><strong>Compile with Warnings</strong><dd> Compile the current editor with suggested Oracle's PL/SQL Warnings (PLW). Fixing these warnings can speed up your code.
+<br><dt><strong>Static Check</strong><dd> Runs external static checker and displays result along with oracle errors and warnings. This button is only visible if static checker has been set up in preferences.
<br><dt><strong>Next error</strong><dd> Move the cursor to the next syntax error in the current editor. For more information about syntax errors in editors see the editor section.
The keyboard shortcut for this is <strong>CTRL+N</strong>.
<br><dt><strong>Previous error</strong><dd> Move the cursor to the previous syntax error in the current editor. For more information about syntax errors in editors see the editor section.
The keyboard shortcut for this is CTRL+P.
</dl>
+<h4 class="subheading">Static check</h4>
+
+<p>Running static check will create a temporary file containing currently open code tab. Then external program will be called with name of temporary file (with full path) given as parameter. Result from that external program should be in specific format in order to be interpreted by TOra.
+
+ <p>TOra expects one line of output (written to stdout) to contain one message from static checker. This line should start with number of line followed by semicolon and then text of message.
+
+ <p><strong>Note:</strong> in future TOra should be able to interpret linenumber, code of static message and then message itself. Code of static message will be used to open automatically generated URL descibing static checker message.
+
+ <p>Example of output from static checker:
+
+<pre class="example"> 72:STC-0100:Comment describing function/procedure and it's parameters is missing
+ 107:STC-0200:Name of procedure "my_procedure" does not comply with naming standard
+</pre>
</body></html>
Modified: trunk/tora/doc/help/plsqleditor.texi
===================================================================
--- trunk/tora/doc/help/plsqleditor.texi 2009-12-30 21:53:43 UTC (rev 3371)
+++ trunk/tora/doc/help/plsqleditor.texi 2010-01-02 11:26:54 UTC (rev 3372)
@@ -29,9 +29,9 @@
The toolbar and menu contain pretty much the same commands with a few exceptions.
@table @asis
-@item @strong{Refresh object list}
+@item @strong{Refresh object list}
Update the @strong{Object} list to the left of the screen. This is first on the toolbar and close to the end in the menu.
- The keyboard shortcut for this is @strong{F5}.
+ The keyboard shortcut for this is @strong{F5}.
Observe that this list is read from the object cache and will not be updated unless you reread the object cache as well
(Available from the File menu.
@item @strong{Select schema}
@@ -40,10 +40,12 @@
@item @strong{New sheet}
Start editing a new object.
@item @strong{Compile}
- Compile the current editor. This will compile the procedure with the debug option,
+ Compile the current editor. This will compile the procedure with the debug option,
if you don't have the debug options you need to recompile it in order to be able to see watches. The keyboard shortcut for this is @strong{F9}.
@item @strong{Compile with Warnings}
Compile the current editor with suggested Oracle's PL/SQL Warnings (PLW). Fixing these warnings can speed up your code.
+@item @strong{Static Check}
+ Runs external static checker and displays result along with oracle errors and warnings. This button is only visible if static checker has been set up in preferences.
@item @strong{Next error}
Move the cursor to the next syntax error in the current editor. For more information about syntax errors in editors see the editor section.
The keyboard shortcut for this is @strong{CTRL+N}.
@@ -52,3 +54,17 @@
The keyboard shortcut for this is CTRL+P.
@end table
+@subheading Static check
+
+Running static check will create a temporary file containing currently open code tab. Then external program will be called with name of temporary file (with full path) given as parameter. Result from that external program should be in specific format in order to be interpreted by TOra.
+
+TOra expects one line of output (written to stdout) to contain one message from static checker. This line should start with number of line followed by semicolon and then text of message.
+
+@strong{Note:} in future TOra should be able to interpret linenumber, code of static message and then message itself. Code of static message will be used to open automatically generated URL descibing static checker message.
+
+Example of output from static checker:
+
+@example
+72:STC-0100:Comment describing function/procedure and it's parameters is missing
+107:STC-0200:Name of procedure "my_procedure" does not comply with naming standard
+@end example
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|