More README src cleanups.

2025-01-12 18:34:36 +08:00 · 2008-03-21 13:23:29 +00:00 · 2008-03-21 13:23:29 +00:00 · fca9fff41b
commit fca9fff41b
parent d287818eb5
41 changed files with 137 additions and 52 deletions
--- a/src/backend/access/heap/README.HOT
+++ b/src/backend/access/heap/README.HOT
@ -1,9 +1,7 @@
-$PostgreSQL: pgsql/src/backend/access/heap/README.HOT,v 1.2 2007/09/21 21:25:42 tgl Exp $
+$PostgreSQL: pgsql/src/backend/access/heap/README.HOT,v 1.3 2008/03/21 13:23:27 momjian Exp $

 Heap Only Tuples (HOT)
-
-Introduction
------------
+======================

 The Heap Only Tuple (HOT) feature eliminates redundant index entries and
 allows the re-use of space taken by DELETEd or obsoleted UPDATEd tuples
--- a/src/backend/access/nbtree/README
+++ b/src/backend/access/nbtree/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/access/nbtree/README,v 1.19 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/access/nbtree/README,v 1.20 2008/03/21 13:23:27 momjian Exp $

 Btree Indexing
--------------
+==============

 This directory contains a correct implementation of Lehman and Yao's
 high-concurrency B-tree management algorithm (P. Lehman and S. Yao,
--- a/src/backend/access/transam/README
+++ b/src/backend/access/transam/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/access/transam/README,v 1.10 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/access/transam/README,v 1.11 2008/03/21 13:23:28 momjian Exp $

 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
--- a/src/backend/catalog/README
+++ b/src/backend/catalog/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/catalog/README,v 1.12 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/catalog/README,v 1.13 2008/03/21 13:23:28 momjian Exp $

 System Catalog
--------------
+==============

 This directory contains .c files that manipulate the system catalogs;
 src/include/catalog contains the .h files that define the structure
--- a/src/backend/executor/README
+++ b/src/backend/executor/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/executor/README,v 1.6 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/executor/README,v 1.7 2008/03/21 13:23:28 momjian Exp $

 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
--- a/src/backend/libpq/README.SSL
+++ b/src/backend/libpq/README.SSL
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/backend/libpq/README.SSL,v 1.6 2008/03/21 13:23:28 momjian Exp $
+
+SSL
+===
+
 >From the servers perspective:


--- a/src/backend/optimizer/README
+++ b/src/backend/optimizer/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/optimizer/README,v 1.42 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/optimizer/README,v 1.43 2008/03/21 13:23:28 momjian Exp $

 Optimizer
---------
+=========

 These directories take the Query structure returned by the parser, and
 generate a plan used by the executor.  The /plan directory generates the
--- a/src/backend/optimizer/plan/README
+++ b/src/backend/optimizer/plan/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/optimizer/plan/README,v 1.2 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/optimizer/plan/README,v 1.3 2008/03/21 13:23:28 momjian Exp $

 Subselects
----------
+==========

 Vadim B. Mikheev

@ -10,7 +10,7 @@ From owner-pgsql-hackers@hub.org Fri Feb 13 09:01:19 1998
 Received: from renoir.op.net (root@renoir.op.net [209.152.193.4])
 	by candle.pha.pa.us (8.8.5/8.8.5) with ESMTP id JAA11576
 	for <maillist@candle.pha.pa.us>; 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 <maillist@candle.pha.pa.us>; 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 <maillist@candle.pha.pa.us>; 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)
--- a/src/backend/parser/README
+++ b/src/backend/parser/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/parser/README,v 1.6 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/parser/README,v 1.7 2008/03/21 13:23:28 momjian Exp $

 Parser
------
+======

 This directory does more than tokenize and parse SQL queries.  It also
 creates Query structures for the various complex queries that are passed
--- a/src/backend/port/darwin/README
+++ b/src/backend/port/darwin/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/port/darwin/README,v 1.4 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/port/darwin/README,v 1.5 2008/03/21 13:23:28 momjian Exp $

 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
--- a/src/backend/port/dynloader/README.dlfcn.aix
+++ b/src/backend/port/dynloader/README.dlfcn.aix
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/backend/port/dynloader/README.dlfcn.aix,v 1.3 2008/03/21 13:23:28 momjian Exp $
+
+dynaloader
+==========
+
 Copyright (c) 1992,1993,1995, Jens-Uwe Mager, Helios Software GmbH
 Not derived from licensed software.

--- a/src/backend/snowball/README
+++ b/src/backend/snowball/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/snowball/README,v 1.2 2008/03/20 17:55:14 momjian Exp $
+$PostgreSQL: pgsql/src/backend/snowball/README,v 1.3 2008/03/21 13:23:28 momjian Exp $

 Snowball-Based Stemming
-----------------------
+=======================

 This module uses the word stemming code developed by the Snowball project,
 http://snowball.tartarus.org/
--- a/src/backend/storage/buffer/README
+++ b/src/backend/storage/buffer/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/storage/buffer/README,v 1.13 2008/03/20 17:55:15 momjian Exp $
+$PostgreSQL: pgsql/src/backend/storage/buffer/README,v 1.14 2008/03/21 13:23:28 momjian Exp $

 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,
--- a/src/backend/storage/lmgr/README
+++ b/src/backend/storage/lmgr/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/storage/lmgr/README,v 1.23 2008/03/20 17:55:15 momjian Exp $
+$PostgreSQL: pgsql/src/backend/storage/lmgr/README,v 1.24 2008/03/21 13:23:28 momjian Exp $

 Locking Overview
----------------
+================

 Postgres uses three types of interprocess locks:

--- a/src/backend/storage/smgr/README
+++ b/src/backend/storage/smgr/README
@ -1,7 +1,7 @@
-# $PostgreSQL: pgsql/src/backend/storage/smgr/README,v 1.4 2008/03/20 17:55:15 momjian Exp $
+$PostgreSQL: pgsql/src/backend/storage/smgr/README,v 1.5 2008/03/21 13:23:28 momjian Exp $

 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
--- a/src/backend/utils/mb/README
+++ b/src/backend/utils/mb/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/utils/mb/README,v 1.6 2008/03/20 17:55:15 momjian Exp $
+$PostgreSQL: pgsql/src/backend/utils/mb/README,v 1.7 2008/03/21 13:23:28 momjian Exp $

 Encodings
---------
+=========

 encnames.c:	public functions for both the backend and the frontend.
 conv.c:		static functions and a public table for code conversion
--- a/src/backend/utils/resowner/README
+++ b/src/backend/utils/resowner/README
@ -1,7 +1,7 @@
-$PostgreSQL: pgsql/src/backend/utils/resowner/README,v 1.6 2008/03/20 17:55:15 momjian Exp $
+$PostgreSQL: pgsql/src/backend/utils/resowner/README,v 1.7 2008/03/21 13:23:28 momjian Exp $

 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
--- a/src/bin/pg_dump/README
+++ b/src/bin/pg_dump/README
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/bin/pg_dump/README,v 1.7 2008/03/21 13:23:28 momjian Exp $
+
 Notes on pg_dump
 ================

--- a/src/bin/pgevent/README
+++ b/src/bin/pgevent/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/bin/pgevent/README,v 1.3 2008/03/21 13:23:28 momjian Exp $
+
+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.
--- a/src/interfaces/ecpg/README.dynSQL
+++ b/src/interfaces/ecpg/README.dynSQL
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/interfaces/ecpg/README.dynSQL,v 1.3 2008/03/21 13:23:28 momjian Exp $
+
 descriptor statements have the following shortcomings

 - input descriptors (USING DESCRIPTOR <name>) are not supported
--- a/src/interfaces/ecpg/test/connect/README
+++ b/src/interfaces/ecpg/test/connect/README
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/interfaces/ecpg/test/connect/README,v 1.2 2008/03/21 13:23:28 momjian Exp $
+
 Programs in this directory test all sorts of connections.

 All other programs just use one standard connection method.
--- a/src/interfaces/libpq/README
+++ b/src/interfaces/libpq/README
@ -1 +1,3 @@
+$PostgreSQL: pgsql/src/interfaces/libpq/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
+
 This directory contains the C version of Libpq, the POSTGRES frontend library.
--- a/src/pl/plperl/README
+++ b/src/pl/plperl/README
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/pl/plperl/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
+
 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
--- a/src/pl/tcl/modules/README
+++ b/src/pl/tcl/modules/README
@ -1,3 +1,4 @@
+$PostgreSQL: pgsql/src/pl/tcl/modules/README,v 1.3 2008/03/21 13:23:29 momjian Exp $

 Regular Tcl scripts of any size (over 8K :-) can be loaded into
 the table pltcl_modules using the pltcl_loadmod script. The script
@ -14,6 +15,5 @@

 I know, this readme should be more explanatory - but time.

-
 Jan

--- a/src/port/README
+++ b/src/port/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/port/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
+
+libpgport
+=========
+
 libpgport must have special behavior.  It supplies functions to both
 libraries and applications.  However, there are two complexities:

--- a/src/test/locale/README
+++ b/src/test/locale/README
@ -1,4 +1,7 @@
-$PostgreSQL: pgsql/src/test/locale/README,v 1.5 2003/11/29 19:52:14 pgsql Exp $
+$PostgreSQL: pgsql/src/test/locale/README,v 1.6 2008/03/21 13:23:29 momjian Exp $
+
+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
--- a/src/test/locale/de_DE.ISO8859-1/README
+++ b/src/test/locale/de_DE.ISO8859-1/README
@ -1,2 +1,4 @@
+$PostgreSQL: pgsql/src/test/locale/de_DE.ISO8859-1/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
+
 de_DE.ISO-8859-1 (German) locale test.
 Created by Armin Diehl <diehl@net-connection.de>
--- a/src/test/locale/gr_GR.ISO8859-7/README
+++ b/src/test/locale/gr_GR.ISO8859-7/README
@ -1,2 +1,4 @@
+$PostgreSQL: pgsql/src/test/locale/gr_GR.ISO8859-7/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
+
 gr_GR.ISO8859-7 (Greek) locale test.
 Created by Angelos Karageorgiou <angelos@awesome.incredible.com>
--- a/src/test/locale/koi8-to-win1251/README
+++ b/src/test/locale/koi8-to-win1251/README
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/test/locale/koi8-to-win1251/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
+
 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 <phd2@earthling.net>. Code for encodings
--- a/src/test/mb/README
+++ b/src/test/mb/README
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/test/mb/README,v 1.3 2008/03/21 13:23:29 momjian Exp $
+
 README for multibyte regression test
 							1998/7/22
 							Tatsuo Ishii
--- a/src/test/thread/README
+++ b/src/test/thread/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/test/thread/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
+
+Threading
+=========
+
 This program should be run by developers wishing to enable threading on
 new platforms.

--- a/src/timezone/README
+++ b/src/timezone/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/timezone/README,v 1.7 2008/03/21 13:23:29 momjian Exp $
+
+Timezone
+========
+
 This is a PostgreSQL adapted version of the timezone library from:

 	ftp://elsie.nci.nih.gov/pub/tzcode*.tar.gz
--- a/src/timezone/tznames/README
+++ b/src/timezone/tznames/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/timezone/tznames/README,v 1.3 2008/03/21 13:23:29 momjian Exp $
+
+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
--- a/src/tools/backend/README
+++ b/src/tools/backend/README
@ -1,3 +1,5 @@
+$PostgreSQL: pgsql/src/tools/backend/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
+
 Just point your browser at the index.html file, and click on the 
 flowchart to see the description and source code.

--- a/src/tools/findoidjoins/README
+++ b/src/tools/findoidjoins/README
@ -1,6 +1,7 @@
-$PostgreSQL: pgsql/src/tools/findoidjoins/README,v 1.4 2007/05/11 17:57:14 tgl Exp $
+$PostgreSQL: pgsql/src/tools/findoidjoins/README,v 1.5 2008/03/21 13:23:29 momjian Exp $

 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
--- a/src/tools/fsync/README
+++ b/src/tools/fsync/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/tools/fsync/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
+
+fsync
+=====
+
 This program tests fsync.  The tests are described as part of the program output.

 	Usage:	test_fsync [-f filename] [loops]
--- a/src/tools/make_diff/README
+++ b/src/tools/make_diff/README
@ -1,6 +1,7 @@
-$PostgreSQL: pgsql/src/tools/make_diff/README,v 1.3 2006/03/11 04:38:42 momjian Exp $
+$PostgreSQL: pgsql/src/tools/make_diff/README,v 1.4 2008/03/21 13:23:29 momjian Exp $

-Bruce Momjian <pgman@candle.pha.pa.us>
+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
+
--- a/src/tools/msvc/README
+++ b/src/tools/msvc/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/tools/msvc/README,v 1.7 2008/03/21 13:23:29 momjian Exp $
+
+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
--- a/src/tools/pginclude/README
+++ b/src/tools/pginclude/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/tools/pginclude/README,v 1.10 2008/03/21 13:23:29 momjian Exp $
+
+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.
--- a/src/tools/pgindent/README
+++ b/src/tools/pgindent/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/tools/pgindent/README,v 1.29 2008/03/21 13:23:29 momjian Exp $
+
+pgindent
+========
+
 This can format all PostgreSQL *.c and *.h files, but excludes *.y, and *.l
 files.

--- a/src/tutorial/README
+++ b/src/tutorial/README
@ -1,3 +1,8 @@
+$PostgreSQL: pgsql/src/tutorial/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
+
+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