pgScript doc updates. [Mickael Deloison]
authordpage <dpage@a7884b65-44f6-0310-8a51-81a127f17b15>
Thu, 12 Mar 2009 16:50:36 +0000 (16:50 +0000)
committerdpage <dpage@a7884b65-44f6-0310-8a51-81a127f17b15>
Thu, 12 Mar 2009 16:50:36 +0000 (16:50 +0000)
git-svn-id: svn://svn.pgadmin.org/trunk/pgadmin3@7691 a7884b65-44f6-0310-8a51-81a127f17b15

pgadmin/pgscript/README
xtra/pgscript/doc/developers.html
xtra/pgscript/doc/readme.html

index 1b90004a8c7eadad4d35b132e5c2a6c1ef746026..2a460c4c4dcdeeed252b74a901bb2dca056d86ae 100644 (file)
@@ -1,13 +1,10 @@
-Please see xtra/pgscript/doc/developers.html for the pgScript developer\r
+Please refer to xtra/pgscript/doc/developers.html for the pgScript developer\r
 documentation.\r
 \r
-parser.sh ust be called for regenerating Flex and Bison source files because it\r
-does some more processing that just executing bison and flex: it replaces some\r
+parser.sh must be called for regenerating Flex and Bison source files because it\r
+does some more processing than just executing Bison and Flex: it replaces some\r
 headers and add other ones.\r
 \r
-Note that the FlexLexer.h file that comes along with your Flex distribution\r
-must be copied to pgadmin/include/pgscript only if you use parser.sh with a\r
-Flex version different from the one used before. Let's say you download pgAdmin\r
-source code and the pgadmin/include/pgscript/FlexLexer.h corresponds to Flex\r
-2.5.33. If you use Flex 2.5.34 you will need to copy FlexLexr.h from your Flex\r
-distribution to pgadmin/include/pgscript.\r
+Please use Flex 2.5.33 otherwise the pgadmin/include/pgscript/FlexLexer.h file\r
+will not be valid. If you use a different version from 2.5.33 you need to copy FlexLexer.h that comes along with your Flex distribution to\r
+pgadmin/include/pgscript.\r
index 06330190657d873270ce9d25b8bbfa6eaed19566..28427360d8af8eb775e386cf25cd1def643139db 100644 (file)
@@ -278,7 +278,7 @@ make</pre>
     would be hard to see if there was a failure.</p>
 <h2><a id="symbols"></a>Preprocessor symbols</h2>
 <h3><a id="symbol1"></a>PGSCLI</h3>
-<p>Automatically defined when compiling the command-line interface. <code>PGSCLI</code> stands for <span class="emphasis"><em>pgScriot Command-Line Interface</em></span>. This
+<p>Automatically defined when compiling the command-line interface. <code>PGSCLI</code> stands for <span class="emphasis"><em>pgScript Command-Line Interface</em></span>. This
     means not to compile specific parts of pgAdmin and pgScript code because the command-line interface does need them: this is mainly GUI code that is ignored.</p>
 <p>Along with <code>PGSCLI</code> <code>PGADMIN3_H</code> is also defined because the command-line must not include <code>pgAdmin3.h</code>. </p>
 <p>When compiled normally with pgAdmin this symbol is not defined.</p>
@@ -292,7 +292,7 @@ make</pre>
 <p><strong class="command">parser.sh</strong> must be called for regenerating
     Flex and Bison source files because it does some more processing that
     just executing <strong class="command">bison</strong> and <strong class="command">flex</strong>:
-    it replaces some headers and add other ones.</p>
+    it replaces some headers and adds other ones.</p>
 <p><code>xtra/pgscript/file/test/execute.sh</code></p>
 <p>See the <a href="#structure">Directory structure</a> section. Runs the
     integration test suite.</p>
index 67005fed1ff57d09cbb387bfafd5cf1a253d94f9..68ff97fc22ea3ead8d9effe6d8789512470f9f05 100644 (file)
@@ -67,7 +67,7 @@
 <pre class="screen">
 make
 ./bin/pgScript</pre>
-<p>You can eventually install pgScript binary:</p>
+<p>You can possibly install pgScript binary:</p>
 <pre class="screen">make install</pre>
 <h2><a id="usage"></a>Usage</h2>
 <h3><a id="usage1"></a>Synopsis</h3>