]> granicus.if.org Git - postgresql/commitdiff
Update pgtools README to be clearer about typdefs.
authorBruce Momjian <bruce@momjian.us>
Thu, 15 Nov 2007 22:09:07 +0000 (22:09 +0000)
committerBruce Momjian <bruce@momjian.us>
Thu, 15 Nov 2007 22:09:07 +0000 (22:09 +0000)
src/tools/pgindent/README

index 3610d46a93f2cb110e60df5dcfcf69a32a5315a8..6a0a926d05a76640a9fd018825cba676761179d6 100644 (file)
@@ -1,20 +1,22 @@
 This can format all PostgreSQL *.c and *.h files, but excludes *.y, and *.l
 files.
 
-To use it, first get the list of typedef's to be included in pgindent by
+1) Get the list of _current_ typedefs to be included in pgindent by
 running this on the pgsql/bin and pgsql/lib directories:
 
        src/tools/find_typedef /usr/local/pgsql/bin /usr/local/pgsql/lib
 
-and update the list in pgindent.  This requires the binaries have debug 
-symbols.
+and update the list in pgindent.  This requires the binaries have
+_debug_  symbols.
 
-From the top directory, run:
+2) From the top directory, run:
 
        find . -name '*.[ch]' -type f -print |
        egrep -v '/s_lock.h|/ecpg/test/expected/|/snowball/libstemmer/' |
        xargs -n100 pgindent
 
+---------------------------------------------------------------------------
+
 We have standardized on NetBSD's indent.  We have fixed a few bugs which 
 requre the NetBSD source to be patched with indent.bsd.patch patch.  A 
 fully patched  version is available at ftp://ftp.postgresql.org/pub/dev.