More README src cleanups.

41 files changed, 120 insertions, 35 deletions

diff --git a/src/backend/access/heap/README.HOT b/src/backend/access/heap/README.HOT
index 4e3b356e80..40025a49e9 100644
--- a/src/backend/access/heap/README.HOT
+++ b/src/backend/access/heap/README.HOT
@@ -1,9 +1,7 @@
 $PostgreSQL$
 
-                           Heap Only Tuples (HOT)
-
-Introduction
-------------
+Heap Only Tuples (HOT)
+======================
 
 The Heap Only Tuple (HOT) feature eliminates redundant index entries and
 allows the re-use of space taken by DELETEd or obsoleted UPDATEd tuples
diff --git a/src/backend/access/nbtree/README b/src/backend/access/nbtree/README
index 30a4aee982..81d56b3a6b 100644
--- a/src/backend/access/nbtree/README
+++ b/src/backend/access/nbtree/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Btree Indexing
---------------
+==============
 
 This directory contains a correct implementation of Lehman and Yao's
 high-concurrency B-tree management algorithm (P. Lehman and S. Yao,
diff --git a/src/backend/access/transam/README b/src/backend/access/transam/README
index 4ea51f2d1b..7d68c2241e 100644
--- a/src/backend/access/transam/README
+++ b/src/backend/access/transam/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 The Transaction System
-----------------------
+======================
 
 PostgreSQL's transaction system is a three-layer system.  The bottom layer
 implements low-level transactions and subtransactions, on top of which rests
diff --git a/src/backend/catalog/README b/src/backend/catalog/README
index 7d05049fe0..96096411fc 100644
--- a/src/backend/catalog/README
+++ b/src/backend/catalog/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 System Catalog
---------------
+==============
 
 This directory contains .c files that manipulate the system catalogs;
 src/include/catalog contains the .h files that define the structure
diff --git a/src/backend/executor/README b/src/backend/executor/README
index 0b1739be06..677bdcbd36 100644
--- a/src/backend/executor/README
+++ b/src/backend/executor/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 The Postgres Executor
----------------------
+=====================
 
 The executor processes a tree of "plan nodes".  The plan tree is essentially
 a demand-pull pipeline of tuple processing operations.  Each node, when
diff --git a/src/backend/libpq/README.SSL b/src/backend/libpq/README.SSL
index b45d53c829..d212ba11dc 100644
--- a/src/backend/libpq/README.SSL
+++ b/src/backend/libpq/README.SSL
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+SSL
+===
+
 >From the servers perspective:
 
 
diff --git a/src/backend/optimizer/README b/src/backend/optimizer/README
index 0f944f0aa1..bccbceea22 100644
--- a/src/backend/optimizer/README
+++ b/src/backend/optimizer/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Optimizer
----------
+=========
 
 These directories take the Query structure returned by the parser, and
 generate a plan used by the executor.  The /plan directory generates the
diff --git a/src/backend/optimizer/plan/README b/src/backend/optimizer/plan/README
index 35174f4e9e..3bcb199ea6 100644
--- a/src/backend/optimizer/plan/README
+++ b/src/backend/optimizer/plan/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Subselects
-----------
+==========
 
 Vadim B. Mikheev
 
@@ -10,7 +10,7 @@ From [email protected] Fri Feb 13 09:01:19 1998
 Received: from renoir.op.net ([email protected] [209.152.193.4])
 	by candle.pha.pa.us (8.8.5/8.8.5) with ESMTP id JAA11576
 	for <[email protected]>; Fri, 13 Feb 1998 09:01:17 -0500 (EST)
-Received: from hub.org (hub.org [209.47.148.200]) by renoir.op.net (o1/$Revision: 1.2 $) with ESMTP id IAA09761 for <[email protected]>; Fri, 13 Feb 1998 08:41:22 -0500 (EST)
+Received: from hub.org (hub.org [209.47.148.200]) by renoir.op.net (o1/$Revision: 1.3 $) with ESMTP id IAA09761 for <[email protected]>; Fri, 13 Feb 1998 08:41:22 -0500 (EST)
 Received: from localhost (majordom@localhost) by hub.org (8.8.8/8.7.5) with SMTP id IAA08135; Fri, 13 Feb 1998 08:40:17 -0500 (EST)
 Received: by hub.org (TLB v0.10a (1.23 tibbs 1997/01/09 00:29:32)); Fri, 13 Feb 1998 08:38:42 -0500 (EST)
 Received: (from majordom@localhost) by hub.org (8.8.8/8.7.5) id IAA06646 for pgsql-hackers-outgoing; Fri, 13 Feb 1998 08:38:35 -0500 (EST)
diff --git a/src/backend/parser/README b/src/backend/parser/README
index 2a6bb15739..9d515e4480 100644
--- a/src/backend/parser/README
+++ b/src/backend/parser/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Parser
-------
+======
 
 This directory does more than tokenize and parse SQL queries.  It also
 creates Query structures for the various complex queries that are passed
diff --git a/src/backend/port/darwin/README b/src/backend/port/darwin/README
index 43b9bbdf5a..b23211990f 100644
--- a/src/backend/port/darwin/README
+++ b/src/backend/port/darwin/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Darwin
-------
+======
 
 The file system.c included herein is taken directly from Apple's Darwin
 open-source CVS archives, and is redistributed under the BSD copyright
diff --git a/src/backend/port/dynloader/README.dlfcn.aix b/src/backend/port/dynloader/README.dlfcn.aix
index e7519086d1..8e7720a9b9 100644
--- a/src/backend/port/dynloader/README.dlfcn.aix
+++ b/src/backend/port/dynloader/README.dlfcn.aix
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+dynaloader
+==========
+
 Copyright (c) 1992,1993,1995, Jens-Uwe Mager, Helios Software GmbH
 Not derived from licensed software.
 
diff --git a/src/backend/snowball/README b/src/backend/snowball/README
index a31ee45686..3607607dd9 100644
--- a/src/backend/snowball/README
+++ b/src/backend/snowball/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Snowball-Based Stemming
------------------------
+=======================
 
 This module uses the word stemming code developed by the Snowball project,
 http://snowball.tartarus.org/
diff --git a/src/backend/storage/buffer/README b/src/backend/storage/buffer/README
index 883b196015..f11c066eec 100644
--- a/src/backend/storage/buffer/README
+++ b/src/backend/storage/buffer/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Notes About Shared Buffer Access Rules
---------------------------------------
+======================================
 
 There are two separate access control mechanisms for shared disk buffers:
 reference counts (a/k/a pin counts) and buffer content locks.  (Actually,
diff --git a/src/backend/storage/lmgr/README b/src/backend/storage/lmgr/README
index 44b606d046..10f0be46c2 100644
--- a/src/backend/storage/lmgr/README
+++ b/src/backend/storage/lmgr/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Locking Overview
-----------------
+================
 
 Postgres uses three types of interprocess locks:
 
diff --git a/src/backend/storage/smgr/README b/src/backend/storage/smgr/README
index e5a1eb4a2e..d8a8d5a08c 100644
--- a/src/backend/storage/smgr/README
+++ b/src/backend/storage/smgr/README
@@ -1,7 +1,7 @@
-# $PostgreSQL$
+$PostgreSQL$
 
 Storage Manager
----------------
+===============
 
 In the original Berkeley Postgres system, there were several storage managers,
 of which only the "magnetic disk" manager remains.  (At Berkeley there were
diff --git a/src/backend/utils/mb/README b/src/backend/utils/mb/README
index f705cbd1f1..5374cc094e 100644
--- a/src/backend/utils/mb/README
+++ b/src/backend/utils/mb/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Encodings
----------
+=========
 
 encnames.c:	public functions for both the backend and the frontend.
 conv.c:		static functions and a public table for code conversion
diff --git a/src/backend/utils/resowner/README b/src/backend/utils/resowner/README
index 2843c86568..67ac81915a 100644
--- a/src/backend/utils/resowner/README
+++ b/src/backend/utils/resowner/README
@@ -1,7 +1,7 @@
 $PostgreSQL$
 
 Notes About Resource Owners
----------------------------
+===========================
 
 ResourceOwner objects are a concept invented to simplify management of
 query-related resources, such as buffer pins and table locks.  These
diff --git a/src/bin/pg_dump/README b/src/bin/pg_dump/README
index 9ed81b00aa..02ec519cf6 100644
--- a/src/bin/pg_dump/README
+++ b/src/bin/pg_dump/README
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 Notes on pg_dump
 ================
 
diff --git a/src/bin/pgevent/README b/src/bin/pgevent/README
index f6a01a619d..b66c52bdd4 100644
--- a/src/bin/pgevent/README
+++ b/src/bin/pgevent/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+pgevent
+=======
+
 MSG000001.bin is a binary file, result of Microsoft MC compiler. MC compiler
 can be downloaded for free with MS Core SDK but it is not included with MSYS
 tools and I didn't find an alternative way to compile MC file.
diff --git a/src/interfaces/ecpg/README.dynSQL b/src/interfaces/ecpg/README.dynSQL
index 4c606ca398..49086deb72 100644
--- a/src/interfaces/ecpg/README.dynSQL
+++ b/src/interfaces/ecpg/README.dynSQL
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 descriptor statements have the following shortcomings
 
 - input descriptors (USING DESCRIPTOR <name>) are not supported
diff --git a/src/interfaces/ecpg/test/connect/README b/src/interfaces/ecpg/test/connect/README
index d2cb50440a..78c92e126f 100644
--- a/src/interfaces/ecpg/test/connect/README
+++ b/src/interfaces/ecpg/test/connect/README
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 Programs in this directory test all sorts of connections.
 
 All other programs just use one standard connection method.
diff --git a/src/interfaces/libpq/README b/src/interfaces/libpq/README
index e581950bf2..e0d3984e83 100644
--- a/src/interfaces/libpq/README
+++ b/src/interfaces/libpq/README
@@ -1 +1,3 @@
+$PostgreSQL$
+
 This directory contains the C version of Libpq, the POSTGRES frontend library.
diff --git a/src/pl/plperl/README b/src/pl/plperl/README
index 317b882c8b..8f6816a295 100644
--- a/src/pl/plperl/README
+++ b/src/pl/plperl/README
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 PL/Perl allows you to write PostgreSQL functions and procedures in
 Perl.  To include PL/Perl in the build use './configure --with-perl'.
 To build from this directory use 'gmake all; gmake install'.  libperl
diff --git a/src/pl/tcl/modules/README b/src/pl/tcl/modules/README
index 2905cfe8cb..885b3d6360 100644
--- a/src/pl/tcl/modules/README
+++ b/src/pl/tcl/modules/README
@@ -1,19 +1,19 @@
+$PostgreSQL$
 
-    Regular Tcl scripts of any size (over 8K :-) can be loaded into
-    the table pltcl_modules using the pltcl_loadmod script. The script
-    checks the modules that the procedure names don't overwrite
-    existing ones before doing anything. They also check for global
-    variables created at load time.
+Regular Tcl scripts of any size (over 8K :-) can be loaded into
+the table pltcl_modules using the pltcl_loadmod script. The script
+checks the modules that the procedure names don't overwrite
+existing ones before doing anything. They also check for global
+variables created at load time.
 
-    All procedures defined in the module files are automatically
-    added to the table pltcl_modfuncs. This table is used by the
-    unknown procedure to determine if an unknown command can be
-    loaded by sourcing a module. In that case the unknown procedure
-    will silently source in the module and reexecute the original
-    command that invoked unknown.
-
-    I know, this readme should be more explanatory - but time.
+All procedures defined in the module files are automatically
+added to the table pltcl_modfuncs. This table is used by the
+unknown procedure to determine if an unknown command can be
+loaded by sourcing a module. In that case the unknown procedure
+will silently source in the module and reexecute the original
+command that invoked unknown.
 
+I know, this readme should be more explanatory - but time.
 
 Jan
 
diff --git a/src/port/README b/src/port/README
index 6a8cf5fd67..dcf7664e4a 100644
--- a/src/port/README
+++ b/src/port/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+libpgport
+=========
+
 libpgport must have special behavior.  It supplies functions to both
 libraries and applications.  However, there are two complexities:
 
diff --git a/src/test/locale/README b/src/test/locale/README
index e8d451b176..2386dac701 100644
--- a/src/test/locale/README
+++ b/src/test/locale/README
@@ -1,5 +1,8 @@
 $PostgreSQL$
 
+Locales
+=======
+
 This directory contains a set of tests for locales.  I provided one C
 program test-ctype.c to test CTYPE support in libc and the installed
 locale data.  Then there are test-sort.pl and test-sort.py that test
diff --git a/src/test/locale/de_DE.ISO8859-1/README b/src/test/locale/de_DE.ISO8859-1/README
index 0ef1c8c5fe..5ffe59fdbf 100644
--- a/src/test/locale/de_DE.ISO8859-1/README
+++ b/src/test/locale/de_DE.ISO8859-1/README
@@ -1,2 +1,4 @@
+$PostgreSQL$
+
 de_DE.ISO-8859-1 (German) locale test.
 Created by Armin Diehl <[email protected]>
diff --git a/src/test/locale/gr_GR.ISO8859-7/README b/src/test/locale/gr_GR.ISO8859-7/README
index 62023d0c8e..b50afe342b 100644
--- a/src/test/locale/gr_GR.ISO8859-7/README
+++ b/src/test/locale/gr_GR.ISO8859-7/README
@@ -1,2 +1,4 @@
+$PostgreSQL$
+
 gr_GR.ISO8859-7 (Greek) locale test.
 Created by Angelos Karageorgiou <[email protected]>
diff --git a/src/test/locale/koi8-to-win1251/README b/src/test/locale/koi8-to-win1251/README
index 1ad3bde81d..666241779b 100644
--- a/src/test/locale/koi8-to-win1251/README
+++ b/src/test/locale/koi8-to-win1251/README
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 koi8-to-win1251 test. The database should be created in koi8 (createdb -E koi8),
 test uses koi8-to-win1251 converting feature.
 Created by Oleg Broytmann <[email protected]>. Code for encodings
diff --git a/src/test/mb/README b/src/test/mb/README
index beb580a0d8..2a8daa8ea5 100644
--- a/src/test/mb/README
+++ b/src/test/mb/README
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 README for multibyte regression test
 							1998/7/22
 							Tatsuo Ishii
diff --git a/src/test/thread/README b/src/test/thread/README
index 107699610e..59383d64ca 100644
--- a/src/test/thread/README
+++ b/src/test/thread/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+Threading
+=========
+
 This program should be run by developers wishing to enable threading on
 new platforms.
 
diff --git a/src/timezone/README b/src/timezone/README
index 96452a9b89..48c1eec925 100644
--- a/src/timezone/README
+++ b/src/timezone/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+Timezone
+========
+
 This is a PostgreSQL adapted version of the timezone library from:
 
 	ftp://elsie.nci.nih.gov/pub/tzcode*.tar.gz
diff --git a/src/timezone/tznames/README b/src/timezone/tznames/README
index 3b1bdcce50..8ef110c851 100644
--- a/src/timezone/tznames/README
+++ b/src/timezone/tznames/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+tznames
+=======
+
 This directory contains files with timezone sets for PostgreSQL.  The problem
 is that time zone abbreviations are not unique throughout the world and you
 might find out that a time zone abbreviation in the `Default' set collides
diff --git a/src/tools/backend/README b/src/tools/backend/README
index 601c66cc4b..b1b029e2a0 100644
--- a/src/tools/backend/README
+++ b/src/tools/backend/README
@@ -1,3 +1,5 @@
+$PostgreSQL$
+
 Just point your browser at the index.html file, and click on the 
 flowchart to see the description and source code.
 
diff --git a/src/tools/findoidjoins/README b/src/tools/findoidjoins/README
index 5d966d7cc5..e3eb5673fc 100644
--- a/src/tools/findoidjoins/README
+++ b/src/tools/findoidjoins/README
@@ -1,6 +1,7 @@
 $PostgreSQL$
 
-   			      findoidjoins
+findoidjoins
+============
 
 This program scans a database and prints oid fields (also reg* fields)
 and the tables they join to.  We don't really recommend running it on
diff --git a/src/tools/fsync/README b/src/tools/fsync/README
index f93f649b0e..cde6932945 100644
--- a/src/tools/fsync/README
+++ b/src/tools/fsync/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+fsync
+=====
+
 This program tests fsync.  The tests are described as part of the program output.
 
 	Usage:	test_fsync [-f filename] [loops]
diff --git a/src/tools/make_diff/README b/src/tools/make_diff/README
index a28f010938..f597d291cc 100644
--- a/src/tools/make_diff/README
+++ b/src/tools/make_diff/README
@@ -1,6 +1,7 @@
 $PostgreSQL$
 
-Bruce Momjian <[email protected]>
+scripts
+=======
 
 Here are some of the scripts I use to make development easier.
 
@@ -35,3 +36,5 @@ the files I used with cporig.
 
 Finally, I remove my old copies with 'rmorig'.
 
+Bruce Momjian
+
diff --git a/src/tools/msvc/README b/src/tools/msvc/README
index 17a480047c..f84fd84e57 100644
--- a/src/tools/msvc/README
+++ b/src/tools/msvc/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+MSVC build
+==========
+
 This directory contains the tools required to build PostgreSQL using
 Microsoft Visual Studio 2005. This builds the whole backend, not just
 the libpq frontend library. For more information, see the documentation
diff --git a/src/tools/pginclude/README b/src/tools/pginclude/README
index dc92735d5f..703a2487c7 100644
--- a/src/tools/pginclude/README
+++ b/src/tools/pginclude/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+pginclude
+=========
+
 These utilities help clean up #include file usage.  They should be run
 in this order so that the include files have the proper includes before
 the C files are tested.
diff --git a/src/tools/pgindent/README b/src/tools/pgindent/README
index 58a0ca2fd9..c05b63ee25 100644
--- a/src/tools/pgindent/README
+++ b/src/tools/pgindent/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+pgindent
+========
+
 This can format all PostgreSQL *.c and *.h files, but excludes *.y, and *.l
 files.
 
diff --git a/src/tutorial/README b/src/tutorial/README
index 6d05cb578f..5dfdd40286 100644
--- a/src/tutorial/README
+++ b/src/tutorial/README
@@ -1,3 +1,8 @@
+$PostgreSQL$
+
+tutorial
+========
+
 This directory contains SQL tutorial scripts.  To look at them, first do a
 	% make
 to compile all the scripts and C files for the user-defined functions