From: dpage Date: Thu, 12 Mar 2009 16:50:36 +0000 (+0000) Subject: pgScript doc updates. [Mickael Deloison] X-Git-Url: http://git.postgresql.org/gitweb/static/gitweb.js?a=commitdiff_plain;h=3e3be8e293a3fd7422c91abe03dd3b273ab23147;p=users%2Fquan74%2Fpgadmin-import.git pgScript doc updates. [Mickael Deloison] git-svn-id: svn://svn.pgadmin.org/trunk/pgadmin3@7691 a7884b65-44f6-0310-8a51-81a127f17b15 --- diff --git a/pgadmin/pgscript/README b/pgadmin/pgscript/README index 1b90004a8..2a460c4c4 100644 --- a/pgadmin/pgscript/README +++ b/pgadmin/pgscript/README @@ -1,13 +1,10 @@ -Please see xtra/pgscript/doc/developers.html for the pgScript developer +Please refer to xtra/pgscript/doc/developers.html for the pgScript developer documentation. -parser.sh ust be called for regenerating Flex and Bison source files because it -does some more processing that just executing bison and flex: it replaces some +parser.sh must be called for regenerating Flex and Bison source files because it +does some more processing than just executing Bison and Flex: it replaces some headers and add other ones. -Note that the FlexLexer.h file that comes along with your Flex distribution -must be copied to pgadmin/include/pgscript only if you use parser.sh with a -Flex version different from the one used before. Let's say you download pgAdmin -source code and the pgadmin/include/pgscript/FlexLexer.h corresponds to Flex -2.5.33. If you use Flex 2.5.34 you will need to copy FlexLexr.h from your Flex -distribution to pgadmin/include/pgscript. +Please use Flex 2.5.33 otherwise the pgadmin/include/pgscript/FlexLexer.h file +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 +pgadmin/include/pgscript. diff --git a/xtra/pgscript/doc/developers.html b/xtra/pgscript/doc/developers.html index 063301906..28427360d 100644 --- a/xtra/pgscript/doc/developers.html +++ b/xtra/pgscript/doc/developers.html @@ -278,7 +278,7 @@ make would be hard to see if there was a failure.

Preprocessor symbols

PGSCLI

-

Automatically defined when compiling the command-line interface. PGSCLI stands for pgScriot Command-Line Interface. This +

Automatically defined when compiling the command-line interface. PGSCLI stands for pgScript Command-Line Interface. 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.

Along with PGSCLI PGADMIN3_H is also defined because the command-line must not include pgAdmin3.h.

When compiled normally with pgAdmin this symbol is not defined.

@@ -292,7 +292,7 @@ make

parser.sh must be called for regenerating Flex and Bison source files because it does some more processing that just executing bison and flex: - it replaces some headers and add other ones.

+ it replaces some headers and adds other ones.

xtra/pgscript/file/test/execute.sh

See the Directory structure section. Runs the integration test suite.

diff --git a/xtra/pgscript/doc/readme.html b/xtra/pgscript/doc/readme.html index 67005fed1..68ff97fc2 100644 --- a/xtra/pgscript/doc/readme.html +++ b/xtra/pgscript/doc/readme.html @@ -67,7 +67,7 @@
 make
 ./bin/pgScript
-

You can eventually install pgScript binary:

+

You can possibly install pgScript binary:

make install

Usage

Synopsis