src/tools/pgindent/README

   1 $PostgreSQL$
   2
   3 pgindent
   4 ========
   5
   6 This can format all PostgreSQL *.c and *.h files, but excludes *.y, and *.l
   7 files.
   8
   9 To use pgindent:
  10
  11 1) Build the source tree with _debug_ symbols and all possible configure options
  12
  13 2) Install to /usr/local/pgsql
  14
  15 3) Install all contrib modules
  16
  17 4) Save a list of typedefs by running:
  18
  19         src/tools/find_typedef /usr/local/pgsql/bin /usr/local/pgsql/lib > /tmp/pgtypedefs
  20
  21 5) Run 'gmake distclean' from the top of the source tree to remove any
  22    derived C files.
  23
  24 6) From the top of the source tree, run:
  25
  26         find . -name '*.[ch]' -type f -print |
  27         egrep -v '/s_lock.h|/ecpg/test/expected/|/snowball/libstemmer/' |
  28         xargs -n100 pgindent /tmp/pgtypedefs
  29
  30 ---------------------------------------------------------------------------
  31
  32 We have standardized on NetBSD's indent.  We have fixed a few bugs which
  33 requre the NetBSD source to be patched with indent.bsd.patch patch.  A
  34 fully patched  version is available at ftp://ftp.postgresql.org/pub/dev.
  35
  36 GNU indent, version 2.2.6, has several problems, and is not recommended.
  37 These bugs become pretty major when you are doing >500k lines of code.
  38 If you don't believe me, take a directory and make a copy.  Run pgindent
  39 on the copy using GNU indent, and do a diff -r. You will see what I
  40 mean. GNU indent does some things better, but mangles too.
  41
  42 Notes about excluded files:
  43
  44 src/include/storage/s_lock.h is excluded because it contains assembly code
  45 that pgindent tends to mess up.
  46
  47 src/interfaces/ecpg/test/expected/ is excluded to avoid breaking the ecpg
  48 regression tests.
  49
  50 src/include/snowball/libstemmer/ and src/backend/snowball/libstemmer/
  51 are excluded because those files are imported from an external project,
  52 not maintained locally, and are machine-generated anyway.