Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit fca9fff

Browse files
committed
More README src cleanups.
1 parent d287818 commit fca9fff

File tree

41 files changed

+137
-52
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+137
-52
lines changed

src/backend/access/heap/README.HOT

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/access/heap/README.HOT,v 1.2 2007/09/21 21:25:42 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/access/heap/README.HOT,v 1.3 2008/03/21 13:23:27 momjian Exp $
22

3-
Heap Only Tuples (HOT)
4-
5-
Introduction
6-
------------
3+
Heap Only Tuples (HOT)
4+
======================
75

86
The Heap Only Tuple (HOT) feature eliminates redundant index entries and
97
allows the re-use of space taken by DELETEd or obsoleted UPDATEd tuples

src/backend/access/nbtree/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/access/nbtree/README,v 1.19 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/access/nbtree/README,v 1.20 2008/03/21 13:23:27 momjian Exp $
22

33
Btree Indexing
4-
--------------
4+
==============
55

66
This directory contains a correct implementation of Lehman and Yao's
77
high-concurrency B-tree management algorithm (P. Lehman and S. Yao,

src/backend/access/transam/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/access/transam/README,v 1.10 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/access/transam/README,v 1.11 2008/03/21 13:23:28 momjian Exp $
22

33
The Transaction System
4-
----------------------
4+
======================
55

66
PostgreSQL's transaction system is a three-layer system. The bottom layer
77
implements low-level transactions and subtransactions, on top of which rests

src/backend/catalog/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/catalog/README,v 1.12 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/catalog/README,v 1.13 2008/03/21 13:23:28 momjian Exp $
22

33
System Catalog
4-
--------------
4+
==============
55

66
This directory contains .c files that manipulate the system catalogs;
77
src/include/catalog contains the .h files that define the structure

src/backend/executor/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/executor/README,v 1.6 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/executor/README,v 1.7 2008/03/21 13:23:28 momjian Exp $
22

33
The Postgres Executor
4-
---------------------
4+
=====================
55

66
The executor processes a tree of "plan nodes". The plan tree is essentially
77
a demand-pull pipeline of tuple processing operations. Each node, when

src/backend/libpq/README.SSL

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/backend/libpq/README.SSL,v 1.6 2008/03/21 13:23:28 momjian Exp $
2+
3+
SSL
4+
===
5+
16
>From the servers perspective:
27

38

src/backend/optimizer/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/optimizer/README,v 1.42 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/optimizer/README,v 1.43 2008/03/21 13:23:28 momjian Exp $
22

33
Optimizer
4-
---------
4+
=========
55

66
These directories take the Query structure returned by the parser, and
77
generate a plan used by the executor. The /plan directory generates the

src/backend/optimizer/plan/README

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/optimizer/plan/README,v 1.2 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/optimizer/plan/README,v 1.3 2008/03/21 13:23:28 momjian Exp $
22

33
Subselects
4-
----------
4+
==========
55

66
Vadim B. Mikheev
77

@@ -10,7 +10,7 @@ From owner-pgsql-hackers@hub.org Fri Feb 13 09:01:19 1998
1010
Received: from renoir.op.net (root@renoir.op.net [209.152.193.4])
1111
by candle.pha.pa.us (8.8.5/8.8.5) with ESMTP id JAA11576
1212
for <maillist@candle.pha.pa.us>; Fri, 13 Feb 1998 09:01:17 -0500 (EST)
13-
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)
13+
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)
1414
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)
1515
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)
1616
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)

src/backend/parser/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/parser/README,v 1.6 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/parser/README,v 1.7 2008/03/21 13:23:28 momjian Exp $
22

33
Parser
4-
------
4+
======
55

66
This directory does more than tokenize and parse SQL queries. It also
77
creates Query structures for the various complex queries that are passed

src/backend/port/darwin/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/port/darwin/README,v 1.4 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/port/darwin/README,v 1.5 2008/03/21 13:23:28 momjian Exp $
22

33
Darwin
4-
------
4+
======
55

66
The file system.c included herein is taken directly from Apple's Darwin
77
open-source CVS archives, and is redistributed under the BSD copyright

src/backend/port/dynloader/README.dlfcn.aix

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/backend/port/dynloader/README.dlfcn.aix,v 1.3 2008/03/21 13:23:28 momjian Exp $
2+
3+
dynaloader
4+
==========
5+
16
Copyright (c) 1992,1993,1995, Jens-Uwe Mager, Helios Software GmbH
27
Not derived from licensed software.
38

src/backend/snowball/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/snowball/README,v 1.2 2008/03/20 17:55:14 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/snowball/README,v 1.3 2008/03/21 13:23:28 momjian Exp $
22

33
Snowball-Based Stemming
4-
-----------------------
4+
=======================
55

66
This module uses the word stemming code developed by the Snowball project,
77
http://snowball.tartarus.org/

src/backend/storage/buffer/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/storage/buffer/README,v 1.13 2008/03/20 17:55:15 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/storage/buffer/README,v 1.14 2008/03/21 13:23:28 momjian Exp $
22

33
Notes About Shared Buffer Access Rules
4-
--------------------------------------
4+
======================================
55

66
There are two separate access control mechanisms for shared disk buffers:
77
reference counts (a/k/a pin counts) and buffer content locks. (Actually,

src/backend/storage/lmgr/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/storage/lmgr/README,v 1.23 2008/03/20 17:55:15 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/storage/lmgr/README,v 1.24 2008/03/21 13:23:28 momjian Exp $
22

33
Locking Overview
4-
----------------
4+
================
55

66
Postgres uses three types of interprocess locks:
77

src/backend/storage/smgr/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# $PostgreSQL: pgsql/src/backend/storage/smgr/README,v 1.4 2008/03/20 17:55:15 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/storage/smgr/README,v 1.5 2008/03/21 13:23:28 momjian Exp $
22

33
Storage Manager
4-
---------------
4+
===============
55

66
In the original Berkeley Postgres system, there were several storage managers,
77
of which only the "magnetic disk" manager remains. (At Berkeley there were

src/backend/utils/mb/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/utils/mb/README,v 1.6 2008/03/20 17:55:15 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/utils/mb/README,v 1.7 2008/03/21 13:23:28 momjian Exp $
22

33
Encodings
4-
---------
4+
=========
55

66
encnames.c: public functions for both the backend and the frontend.
77
conv.c: static functions and a public table for code conversion

src/backend/utils/resowner/README

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/utils/resowner/README,v 1.6 2008/03/20 17:55:15 momjian Exp $
1+
$PostgreSQL: pgsql/src/backend/utils/resowner/README,v 1.7 2008/03/21 13:23:28 momjian Exp $
22

33
Notes About Resource Owners
4-
---------------------------
4+
===========================
55

66
ResourceOwner objects are a concept invented to simplify management of
77
query-related resources, such as buffer pins and table locks. These

src/bin/pg_dump/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/bin/pg_dump/README,v 1.7 2008/03/21 13:23:28 momjian Exp $
2+
13
Notes on pg_dump
24
================
35

src/bin/pgevent/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/bin/pgevent/README,v 1.3 2008/03/21 13:23:28 momjian Exp $
2+
3+
pgevent
4+
=======
5+
16
MSG000001.bin is a binary file, result of Microsoft MC compiler. MC compiler
27
can be downloaded for free with MS Core SDK but it is not included with MSYS
38
tools and I didn't find an alternative way to compile MC file.

src/interfaces/ecpg/README.dynSQL

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/interfaces/ecpg/README.dynSQL,v 1.3 2008/03/21 13:23:28 momjian Exp $
2+
13
descriptor statements have the following shortcomings
24

35
- input descriptors (USING DESCRIPTOR <name>) are not supported

src/interfaces/ecpg/test/connect/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/interfaces/ecpg/test/connect/README,v 1.2 2008/03/21 13:23:28 momjian Exp $
2+
13
Programs in this directory test all sorts of connections.
24

35
All other programs just use one standard connection method.

src/interfaces/libpq/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
$PostgreSQL: pgsql/src/interfaces/libpq/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
2+
13
This directory contains the C version of Libpq, the POSTGRES frontend library.

src/pl/plperl/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/pl/plperl/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
2+
13
PL/Perl allows you to write PostgreSQL functions and procedures in
24
Perl. To include PL/Perl in the build use './configure --with-perl'.
35
To build from this directory use 'gmake all; gmake install'. libperl

src/pl/tcl/modules/README

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1+
$PostgreSQL: pgsql/src/pl/tcl/modules/README,v 1.3 2008/03/21 13:23:29 momjian Exp $
12

2-
Regular Tcl scripts of any size (over 8K :-) can be loaded into
3-
the table pltcl_modules using the pltcl_loadmod script. The script
4-
checks the modules that the procedure names don't overwrite
5-
existing ones before doing anything. They also check for global
6-
variables created at load time.
3+
Regular Tcl scripts of any size (over 8K :-) can be loaded into
4+
the table pltcl_modules using the pltcl_loadmod script. The script
5+
checks the modules that the procedure names don't overwrite
6+
existing ones before doing anything. They also check for global
7+
variables created at load time.
78

8-
All procedures defined in the module files are automatically
9-
added to the table pltcl_modfuncs. This table is used by the
10-
unknown procedure to determine if an unknown command can be
11-
loaded by sourcing a module. In that case the unknown procedure
12-
will silently source in the module and reexecute the original
13-
command that invoked unknown.
14-
15-
I know, this readme should be more explanatory - but time.
9+
All procedures defined in the module files are automatically
10+
added to the table pltcl_modfuncs. This table is used by the
11+
unknown procedure to determine if an unknown command can be
12+
loaded by sourcing a module. In that case the unknown procedure
13+
will silently source in the module and reexecute the original
14+
command that invoked unknown.
1615

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

1818
Jan
1919

src/port/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/port/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
2+
3+
libpgport
4+
=========
5+
16
libpgport must have special behavior. It supplies functions to both
27
libraries and applications. However, there are two complexities:
38

src/test/locale/README

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
$PostgreSQL: pgsql/src/test/locale/README,v 1.5 2003/11/29 19:52:14 pgsql Exp $
1+
$PostgreSQL: pgsql/src/test/locale/README,v 1.6 2008/03/21 13:23:29 momjian Exp $
2+
3+
Locales
4+
=======
25

36
This directory contains a set of tests for locales. I provided one C
47
program test-ctype.c to test CTYPE support in libc and the installed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
$PostgreSQL: pgsql/src/test/locale/de_DE.ISO8859-1/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
2+
13
de_DE.ISO-8859-1 (German) locale test.
24
Created by Armin Diehl <diehl@net-connection.de>
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
$PostgreSQL: pgsql/src/test/locale/gr_GR.ISO8859-7/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
2+
13
gr_GR.ISO8859-7 (Greek) locale test.
24
Created by Angelos Karageorgiou <angelos@awesome.incredible.com>

src/test/locale/koi8-to-win1251/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/test/locale/koi8-to-win1251/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
2+
13
koi8-to-win1251 test. The database should be created in koi8 (createdb -E koi8),
24
test uses koi8-to-win1251 converting feature.
35
Created by Oleg Broytmann <phd2@earthling.net>. Code for encodings

src/test/mb/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/test/mb/README,v 1.3 2008/03/21 13:23:29 momjian Exp $
2+
13
README for multibyte regression test
24
1998/7/22
35
Tatsuo Ishii

src/test/thread/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/test/thread/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
2+
3+
Threading
4+
=========
5+
16
This program should be run by developers wishing to enable threading on
27
new platforms.
38

src/timezone/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/timezone/README,v 1.7 2008/03/21 13:23:29 momjian Exp $
2+
3+
Timezone
4+
========
5+
16
This is a PostgreSQL adapted version of the timezone library from:
27

38
ftp://elsie.nci.nih.gov/pub/tzcode*.tar.gz

src/timezone/tznames/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/timezone/tznames/README,v 1.3 2008/03/21 13:23:29 momjian Exp $
2+
3+
tznames
4+
=======
5+
16
This directory contains files with timezone sets for PostgreSQL. The problem
27
is that time zone abbreviations are not unique throughout the world and you
38
might find out that a time zone abbreviation in the `Default' set collides

src/tools/backend/README

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/tools/backend/README,v 1.2 2008/03/21 13:23:29 momjian Exp $
2+
13
Just point your browser at the index.html file, and click on the
24
flowchart to see the description and source code.
35

src/tools/findoidjoins/README

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
$PostgreSQL: pgsql/src/tools/findoidjoins/README,v 1.4 2007/05/11 17:57:14 tgl Exp $
1+
$PostgreSQL: pgsql/src/tools/findoidjoins/README,v 1.5 2008/03/21 13:23:29 momjian Exp $
22

3-
findoidjoins
3+
findoidjoins
4+
============
45

56
This program scans a database and prints oid fields (also reg* fields)
67
and the tables they join to. We don't really recommend running it on

src/tools/fsync/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/tools/fsync/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
2+
3+
fsync
4+
=====
5+
16
This program tests fsync. The tests are described as part of the program output.
27

38
Usage: test_fsync [-f filename] [loops]

src/tools/make_diff/README

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
$PostgreSQL: pgsql/src/tools/make_diff/README,v 1.3 2006/03/11 04:38:42 momjian Exp $
1+
$PostgreSQL: pgsql/src/tools/make_diff/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
22

3-
Bruce Momjian <pgman@candle.pha.pa.us>
3+
scripts
4+
=======
45

56
Here are some of the scripts I use to make development easier.
67

@@ -35,3 +36,5 @@ the files I used with cporig.
3536

3637
Finally, I remove my old copies with 'rmorig'.
3738

39+
Bruce Momjian
40+

src/tools/msvc/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/tools/msvc/README,v 1.7 2008/03/21 13:23:29 momjian Exp $
2+
3+
MSVC build
4+
==========
5+
16
This directory contains the tools required to build PostgreSQL using
27
Microsoft Visual Studio 2005. This builds the whole backend, not just
38
the libpq frontend library. For more information, see the documentation

src/tools/pginclude/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/tools/pginclude/README,v 1.10 2008/03/21 13:23:29 momjian Exp $
2+
3+
pginclude
4+
=========
5+
16
These utilities help clean up #include file usage. They should be run
27
in this order so that the include files have the proper includes before
38
the C files are tested.

src/tools/pgindent/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/tools/pgindent/README,v 1.29 2008/03/21 13:23:29 momjian Exp $
2+
3+
pgindent
4+
========
5+
16
This can format all PostgreSQL *.c and *.h files, but excludes *.y, and *.l
27
files.
38

src/tutorial/README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/tutorial/README,v 1.4 2008/03/21 13:23:29 momjian Exp $
2+
3+
tutorial
4+
========
5+
16
This directory contains SQL tutorial scripts. To look at them, first do a
27
% make
38
to compile all the scripts and C files for the user-defined functions

0 commit comments

Comments
 (0)