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