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

Commit 4e22844

Browse files
committed
Make source code READMEs more consistent. Add CVS tags to all README files.
1 parent 27dfc11 commit 4e22844

File tree

22 files changed

+149
-94
lines changed

22 files changed

+149
-94
lines changed

src/backend/access/gin/README

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
$PostgreSQL: pgsql/src/backend/access/gin/README,v 1.5 2008/03/20 17:55:14 momjian Exp $
2+
13
Gin for PostgreSQL
24
==================
35

src/backend/access/gist/README

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/access/gist/README,v 1.3 2005/09/16 14:40:54 teodor Exp $
1+
$PostgreSQL: pgsql/src/backend/access/gist/README,v 1.4 2008/03/20 17:55:14 momjian Exp $
2+
3+
GiST Indexing
4+
=============
25

36
This directory contains an implementation of GiST indexing for Postgres.
47

@@ -48,7 +51,8 @@ core and PostgreSQL WAL system. Moreover, we encountered (and solved)
4851
a problem of uncompleted insertions when recovering after crash, which
4952
was not touched in the paper.
5053

51-
SEARCH ALGORITHM
54+
Search Algorithm
55+
----------------
5256

5357
Function gettuple finds a tuple which satisfies the search
5458
predicate. It store their state and returns next tuple under
@@ -92,7 +96,8 @@ gettuple(search-pred)
9296
end
9397

9498

95-
INSERT ALGORITHM
99+
Insert Algorithm
100+
----------------
96101

97102
INSERT guarantees that the GiST tree remains balanced. User defined key method
98103
Penalty is used for choosing a subtree to insert; method PickSplit is used for

src/backend/access/hash/README

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/access/hash/README,v 1.7 2008/03/15 20:46:31 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/access/hash/README,v 1.8 2008/03/20 17:55:14 momjian Exp $
2+
3+
Hash Indexing
4+
=============
25

36
This directory contains an implementation of hash indexing for Postgres. Most
47
of the core ideas are taken from Margo Seltzer and Ozan Yigit, A New Hashing
@@ -30,7 +33,7 @@ in other buckets, but we never give them back to the operating system.
3033
There is no provision for reducing the number of buckets, either.
3134

3235

33-
Page addressing
36+
Page Addressing
3437
---------------
3538

3639
There are four kinds of pages in a hash index: the meta page (page zero),
@@ -111,7 +114,7 @@ first bitmap page, which is allocated during index creation just after all
111114
the initially created buckets.
112115

113116

114-
Lock definitions
117+
Lock Definitions
115118
----------------
116119

117120
We use both lmgr locks ("heavyweight" locks) and buffer context locks
@@ -166,7 +169,7 @@ be held at a time by any one process. (The third restriction is probably
166169
stronger than necessary, but it makes the proof of no deadlock obvious.)
167170

168171

169-
Pseudocode algorithms
172+
Pseudocode Algorithms
170173
---------------------
171174

172175
The operations we need to support are: readers scanning the index for
@@ -324,7 +327,7 @@ The exclusive lock request could deadlock in some strange scenarios, but
324327
we can just error out without any great harm being done.
325328

326329

327-
Free space management
330+
Free Space Management
328331
---------------------
329332

330333
(Question: why is this so complicated? Why not just have a linked list
@@ -429,7 +432,7 @@ All the freespace operations should be called while holding no buffer
429432
locks. Since they need no lmgr locks, deadlock is not possible.
430433

431434

432-
Other notes
435+
Other Notes
433436
-----------
434437

435438
All the shenanigans with locking prevent a split occurring while *another*

src/backend/access/nbtree/README

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/access/nbtree/README,v 1.18 2007/09/12 22:10:26 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/access/nbtree/README,v 1.19 2008/03/20 17:55:14 momjian Exp $
2+
3+
Btree Indexing
4+
--------------
25

36
This directory contains a correct implementation of Lehman and Yao's
47
high-concurrency B-tree management algorithm (P. Lehman and S. Yao,
@@ -8,7 +11,7 @@ use a simplified version of the deletion logic described in Lanin and
811
Shasha (V. Lanin and D. Shasha, A Symmetric Concurrent B-Tree Algorithm,
912
Proceedings of 1986 Fall Joint Computer Conference, pp 380-389).
1013

11-
The Lehman and Yao algorithm and insertions
14+
The Lehman and Yao Algorithm and Insertions
1215
-------------------------------------------
1316

1417
We have made the following changes in order to incorporate the L&Y algorithm
@@ -125,7 +128,7 @@ each of the resulting pages. Note we must include the incoming item in
125128
this calculation, otherwise it is possible to find that the incoming
126129
item doesn't fit on the split page where it needs to go!
127130

128-
The deletion algorithm
131+
The Deletion Algorithm
129132
----------------------
130133

131134
Before deleting a leaf item, we get a super-exclusive lock on the target
@@ -320,7 +323,7 @@ positives, so long as it never gives a false negative. This makes it
320323
possible to implement the test with a small counter value stored on each
321324
index page.
322325

323-
On-the-fly deletion of index tuples
326+
On-the-Fly Deletion Of Index Tuples
324327
-----------------------------------
325328

326329
If a process visits a heap tuple and finds that it's dead and removable
@@ -357,7 +360,7 @@ and so cannot remove the heap tuple. This is another reason why
357360
btbulkdelete has to get super-exclusive lock on every leaf page, not only
358361
the ones where it actually sees items to delete.
359362

360-
WAL considerations
363+
WAL Considerations
361364
------------------
362365

363366
The insertion and deletion algorithms in themselves don't guarantee btree
@@ -398,7 +401,7 @@ of the WAL entry.) If the parent page becomes half-dead but is not
398401
immediately deleted due to a subsequent crash, there is no loss of
399402
consistency, and the empty page will be picked up by the next VACUUM.
400403

401-
Other things that are handy to know
404+
Other Things That Are Handy to Know
402405
-----------------------------------
403406

404407
Page zero of every btree is a meta-data page. This page stores the
@@ -443,7 +446,7 @@ original search scankey is consulted as each index entry is sequentially
443446
scanned to decide whether to return the entry and whether the scan can
444447
stop (see _bt_checkkeys()).
445448

446-
Notes about data representation
449+
Notes About Data Representation
447450
-------------------------------
448451

449452
The right-sibling link required by L&Y is kept in the page "opaque
@@ -477,7 +480,7 @@ item is irrelevant, and need not be stored at all. This arrangement
477480
corresponds to the fact that an L&Y non-leaf page has one more pointer
478481
than key.
479482

480-
Notes to operator class implementors
483+
Notes to Operator Class Implementors
481484
------------------------------------
482485

483486
With this implementation, we require each supported combination of

src/backend/access/transam/README

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
$PostgreSQL: pgsql/src/backend/access/transam/README,v 1.9 2007/09/08 20:31:14 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/access/transam/README,v 1.10 2008/03/20 17:55:14 momjian Exp $
22

33
The Transaction System
44
----------------------
@@ -145,7 +145,7 @@ finishing of transactions and subtransactions. For example, AtStart_Memory
145145
takes care of initializing the memory subsystem at main transaction start.
146146

147147

148-
Subtransaction handling
148+
Subtransaction Handling
149149
-----------------------
150150

151151
Subtransactions are implemented using a stack of TransactionState structures,
@@ -187,7 +187,7 @@ Another difference is that BeginInternalSubtransaction is allowed when no
187187
explicit transaction block has been established, while DefineSavepoint is not.
188188

189189

190-
Transaction and subtransaction numbering
190+
Transaction and Subtransaction Numbering
191191
----------------------------------------
192192

193193
Transactions and subtransactions are assigned permanent XIDs only when/if
@@ -221,7 +221,7 @@ InvalidSubTransactionId.) Note that subtransactions do not have their
221221
own VXIDs; they use the parent top transaction's VXID.
222222

223223

224-
Interlocking transaction begin, transaction end, and snapshots
224+
Interlocking Transaction Begin, Transaction End, and Snapshots
225225
--------------------------------------------------------------
226226

227227
We try hard to minimize the amount of overhead and lock contention involved
@@ -375,7 +375,7 @@ for pg_clog are implemented in transam.c, while the low-level functions are in
375375
clog.c. pg_subtrans is contained completely in subtrans.c.
376376

377377

378-
Write-Ahead Log coding
378+
Write-Ahead Log Coding
379379
----------------------
380380

381381
The WAL subsystem (also called XLOG in the code) exists to guarantee crash

src/backend/catalog/README

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
$PostgreSQL: pgsql/src/backend/catalog/README,v 1.11 2007/05/11 17:57:11 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/catalog/README,v 1.12 2008/03/20 17:55:14 momjian Exp $
2+
3+
System Catalog
4+
--------------
25

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

src/backend/executor/README

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
$PostgreSQL: pgsql/src/backend/executor/README,v 1.5 2005/04/28 21:47:12 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/executor/README,v 1.6 2008/03/20 17:55:14 momjian Exp $
22

33
The Postgres Executor
44
---------------------
@@ -137,7 +137,7 @@ be hidden inside function calls). This case has a flow of control like
137137
(a separate FreeExprContext call is not necessary)
138138

139139

140-
EvalPlanQual (READ COMMITTED update checking)
140+
EvalPlanQual (READ COMMITTED Update Checking)
141141
---------------------------------------------
142142

143143
For simple SELECTs, the executor need only pay attention to tuples that are

src/backend/nodes/README

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
*******************************************************************************
2-
* *
3-
* EXPLANATION OF THE NODE STRUCTURES *
4-
* - Andrew Yu (11/94) *
5-
* *
6-
* Copyright (c) 1994, Regents of the University of California *
7-
* *
8-
* $PostgreSQL: pgsql/src/backend/nodes/README,v 1.2 2003/11/29 22:39:45 pgsql Exp $
9-
* *
10-
*******************************************************************************
11-
12-
INTRODUCTION
1+
$PostgreSQL: pgsql/src/backend/nodes/README,v 1.3 2008/03/20 17:55:14 momjian Exp $
2+
3+
Node Structures
4+
===============
5+
6+
Andrew Yu (11/94)
7+
8+
Introduction
9+
------------
1310

1411
The current node structures are plain old C structures. "Inheritance" is
1512
achieved by convention. No additional functions will be generated. Functions
@@ -36,7 +33,8 @@ FILES IN THIS DIRECTORY
3633
memnodes.h - memory nodes
3734

3835

39-
STEPS TO ADD A NODE
36+
Steps to Add a Node
37+
-------------------
4038

4139
Suppose you wana define a node Foo:
4240

@@ -51,7 +49,8 @@ Suppose you wana define a node Foo:
5149
bother writing a creator function in makefuncs.c)
5250

5351

54-
HISTORICAL NOTE
52+
Historical Note
53+
---------------
5554

5655
Prior to the current simple C structure definitions, the Node structures
5756
uses a pseudo-inheritance system which automatically generates creator and

src/backend/optimizer/README

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Summary
2-
-------
1+
$PostgreSQL: pgsql/src/backend/optimizer/README,v 1.42 2008/03/20 17:55:14 momjian Exp $
2+
3+
Optimizer
4+
---------
35

46
These directories take the Query structure returned by the parser, and
57
generate a plan used by the executor. The /plan directory generates the
@@ -180,7 +182,7 @@ to see which join style should be applied for a valid join, ie,
180182
JOIN_INNER, JOIN_LEFT, etc.)
181183

182184

183-
Valid OUTER JOIN optimizations
185+
Valid OUTER JOIN Optimizations
184186
------------------------------
185187

186188
The planner's treatment of outer join reordering is based on the following
@@ -236,7 +238,7 @@ set must be expanded to include the whole of the lower OJ, thereby
236238
preventing it from being formed before the lower OJ is.)
237239

238240

239-
Pulling up subqueries
241+
Pulling Up Subqueries
240242
---------------------
241243

242244
As we described above, a subquery appearing in the range table is planned

src/backend/optimizer/plan/README

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
Subselect notes from Vadim.
1+
$PostgreSQL: pgsql/src/backend/optimizer/plan/README,v 1.2 2008/03/20 17:55:14 momjian Exp $
22

3+
Subselects
4+
----------
5+
6+
Vadim B. Mikheev
37

48

59
From owner-pgsql-hackers@hub.org Fri Feb 13 09:01:19 1998
610
Received: from renoir.op.net (root@renoir.op.net [209.152.193.4])
711
by candle.pha.pa.us (8.8.5/8.8.5) with ESMTP id JAA11576
812
for <maillist@candle.pha.pa.us>; Fri, 13 Feb 1998 09:01:17 -0500 (EST)
9-
Received: from hub.org (hub.org [209.47.148.200]) by renoir.op.net (o1/$Revision: 1.1 $) 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.2 $) with ESMTP id IAA09761 for <maillist@candle.pha.pa.us>; Fri, 13 Feb 1998 08:41:22 -0500 (EST)
1014
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)
1115
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)
1216
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

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/backend/parser/README,v 1.6 2008/03/20 17:55:14 momjian Exp $
2+
3+
Parser
4+
------
5+
16
This directory does more than tokenize and parse SQL queries. It also
27
creates Query structures for the various complex queries that are passed
38
to the optimizer and then executor.

src/backend/port/darwin/README

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
$PostgreSQL: pgsql/src/backend/port/darwin/README,v 1.4 2008/03/20 17:55:14 momjian Exp $
2+
3+
Darwin
4+
------
5+
16
The file system.c included herein is taken directly from Apple's Darwin
27
open-source CVS archives, and is redistributed under the BSD copyright
38
notice it bears. (According to Apple's CVS logs, their version is

src/backend/snowball/README

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Snowball-based stemming
1+
$PostgreSQL: pgsql/src/backend/snowball/README,v 1.2 2008/03/20 17:55:14 momjian Exp $
2+
3+
Snowball-Based Stemming
24
-----------------------
35

46
This module uses the word stemming code developed by the Snowball project,

src/backend/storage/buffer/README

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
$PostgreSQL: pgsql/src/backend/storage/buffer/README,v 1.12 2007/05/30 20:11:58 tgl Exp $
1+
$PostgreSQL: pgsql/src/backend/storage/buffer/README,v 1.13 2008/03/20 17:55:15 momjian Exp $
22

3-
Notes about shared buffer access rules
3+
Notes About Shared Buffer Access Rules
44
--------------------------------------
55

66
There are two separate access control mechanisms for shared disk buffers:
@@ -92,7 +92,7 @@ for VACUUM's use, since we don't allow multiple VACUUMs concurrently on a
9292
single relation anyway.
9393

9494

95-
Buffer manager's internal locking
95+
Buffer Manager's Internal Locking
9696
---------------------------------
9797

9898
Before PostgreSQL 8.1, all operations of the shared buffer manager itself
@@ -152,7 +152,7 @@ we could use per-backend LWLocks instead (a buffer header would then contain
152152
a field to show which backend is doing its I/O).
153153

154154

155-
Normal buffer replacement strategy
155+
Normal Buffer Replacement Strategy
156156
----------------------------------
157157

158158
There is a "free list" of buffers that are prime candidates for replacement.
@@ -201,7 +201,7 @@ have to give up and try another buffer. This however is not a concern
201201
of the basic select-a-victim-buffer algorithm.)
202202

203203

204-
Buffer ring replacement strategy
204+
Buffer Ring Replacement Strategy
205205
---------------------------------
206206

207207
When running a query that needs to access a large number of pages just once,
@@ -236,7 +236,7 @@ buffer, resulting in excessive WAL flushing. Allowing VACUUM to update
236236
256KB between WAL flushes should be more efficient.
237237

238238

239-
Background writer's processing
239+
Background Writer's Processing
240240
------------------------------
241241

242242
The background writer is designed to write out pages that are likely to be

0 commit comments

Comments
 (0)