Skip to content

Commit 450b47e

Browse files
author
Thomas G. Lockhart
committed
Add Y2K statement for intros.
Make sure notation section is included in most intros.
1 parent 2931710 commit 450b47e

File tree

8 files changed

+144
-28
lines changed

8 files changed

+144
-28
lines changed

‎doc/src/sgml/admin.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ $log$
1616
<!entity info SYSTEM "info.sgml">
1717
<!entity legal SYSTEM "legal.sgml">
1818
<!entity notation SYSTEM "notation.sgml">
19+
<!entity y2k SYSTEM "y2k.sgml">
1920

2021
<!entity intro-ag SYSTEM "intro-ag.sgml">
2122
<!entity install SYSTEM "install.sgml">

‎doc/src/sgml/intro-ag.sgml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,12 @@ The <ProductName>Postgres</ProductName> project,
1717
Foundation (<Acronym>NSF</Acronym>), and ESL, Inc.
1818
</Para>
1919

20+
&info;
21+
2022
&notation;
2123

24+
&y2k;
25+
2226
&legal;
2327

2428
</Chapter>

‎doc/src/sgml/intro-pg.sgml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<TITLE>Introduction</TITLE>
33

44
<Para>
5-
This document is the programmer's manual for the
6-
<Ulink url="http://postgresql.org/"><ProductName>PostgreSQL</ProductName></Ulink>
7-
database management system, originally developed at the University
8-
of California at Berkeley.
5+
This document is the programmer's manual for the
6+
<Ulink url="http://postgresql.org/"><ProductName>PostgreSQL</ProductName></Ulink>
7+
database management system, originally developed at the University
8+
of California at Berkeley.
99

1010
<ProductName>PostgreSQL</ProductName> is based on
1111
<Ulink url="http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/postgres.html">
@@ -18,16 +18,16 @@ The <ProductName>Postgres</ProductName> project,
1818
</Para>
1919

2020
<Para>
21-
The first part of this manual
22-
explains the <ProductName>Postgres</ProductName>
21+
The first part of this manual
22+
explains the <ProductName>Postgres</ProductName>
2323
approach to extensibility and describe how
24-
users can extend <ProductName>Postgres</ProductName>
24+
users can extend <ProductName>Postgres</ProductName>
2525
by adding user-defined types,
26-
operators, aggregates, and both query language and programming
26+
operators, aggregates, and both query language and programming
2727
language functions.
28-
After an extremely brief
29-
overview of the <ProductName>Postgres</ProductName> rule system, we discuss
30-
the trigger and SPI interfaces.
28+
After a discussion of the <ProductName>Postgres</ProductName>
29+
rule system, we discuss
30+
the trigger and SPI interfaces.
3131
The manual concludes with a detailed description of
3232
the programming interfaces and
3333
support libraries for various languages.
@@ -37,8 +37,12 @@ the programming interfaces and
3737
We assume proficiency with UNIX and C programming.
3838
</Para>
3939

40+
&info;
41+
4042
&notation;
4143

44+
&y2k;
45+
4246
&legal;
4347

4448
</Chapter>

‎doc/src/sgml/intro.sgml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ have recently incorporated features pioneered by <ProductName>Postgres</ProductN
7474

7575
&info;
7676

77+
&notation;
78+
79+
&y2k;
80+
7781
&legal;
7882

7983
</Chapter>

‎doc/src/sgml/notation.sgml

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,23 @@ particular set of installed
1414

1515
<para>
1616
The
17-
<Productname>Postgres</Productname> <firstterm>super-user</firstterm>
17+
<Productname>Postgres</Productname> <firstterm>superuser</firstterm>
1818
is the user named <replaceable>postgres</replaceable>
1919
who owns the <Productname>Postgres</Productname>
20-
binaries and database files. As the database super-user, all
20+
binaries and database files. As the database superuser, all
2121
protection mechanisms may be bypassed and any data accessed
2222
arbitrarily.
23-
In addition, the <Productname>Postgres</Productname> super-user is allowed to execute
23+
In addition, the <Productname>Postgres</Productname> superuser is allowed to execute
2424
some support programs which are generally not available to all users.
25-
Note that the <Productname>Postgres</Productname> super-user is
25+
Note that the <Productname>Postgres</Productname> superuser is
2626
<emphasis>not</emphasis>
27-
the same as the Unix super-user (<literal>root</literal>),
28-
and should have a non-zero userid for security reasons.
27+
the same as the Unix superuser (which will be referred to as <firstterm>root</firstterm>).
28+
The superuser should have a non-zero user identifier (<firstterm>UID</firstterm>)
29+
for security reasons.
2930

3031
<para>
3132
The
32-
<firstterm>database base administrator</firstterm>
33+
<firstterm>database administrator</firstterm>
3334
or <acronym>DBA</acronym>, is the person who is responsible for installing
3435
<Productname>Postgres</Productname> with mechanisms to
3536
enforce a security policy for a site. The DBA can add new users by
@@ -62,12 +63,34 @@ site.
6263
<title>Notation</title>
6364

6465
<para>
65-
<quote>...</quote> at the front of a file name is used to represent the
66-
path to the <Productname>Postgres</Productname> super-user's home directory.
67-
Anything in brackets
68-
<quote>[</quote> and <quote>]</quote>) is optional. Anything in braces
69-
(<quote>{</quote> and <quote>}</quote>) can be repeated 0 or more times.
70-
Parentheses (<quote>(</quote> and <quote>)</quote>) are used to group boolean
66+
<quote>...</quote> or <filename>/usr/local/pgsql/<filename>
67+
at the front of a file name is used to represent the
68+
path to the <Productname>Postgres</Productname> superuser's home directory.
69+
70+
<para>
71+
In a command synopsis, brackets
72+
<quote>[</quote> and <quote>]</quote>) indicate an optional phrase or keyword.
73+
Anything in braces
74+
(<quote>{</quote> and <quote>}</quote>) and containing vertical bars (<quote>|</quote>)
75+
indicates that you must choose one.
76+
77+
<para>
78+
In examples, parentheses (<quote>(</quote> and <quote>)</quote>) are used to group boolean
7179
expressions. <quote>|</quote> is the boolean operator OR.
7280

73-
</sect1>
81+
<para>
82+
Examples will show commands executed from various accounts and programs.
83+
Commands executed from the root account will be preceeded with <quote>&gt;</quote>.
84+
Commands executed from the superuser account will be preceeded with <quote>$</quote>.
85+
<acronym>SQL</acronym> commands will be preceeded with <quote>=&gt;</quote>
86+
or will have no leading prompt.
87+
88+
<note>
89+
<para>
90+
At the time of writing (<Productname>Postgres</Productname> v6.4) the notation for
91+
flagging commands is not universally consistant throughout the documentation set.
92+
Please report problems to
93+
<ulink url="mailto:docs@postgresql.org">the Documentation Mailing List</ulink>.
94+
</note>
95+
96+
</sect1>

‎doc/src/sgml/postgres.sgml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.10 1998/10/21 05:31:52 thomas Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.11 1998/10/25 00:24:31 thomas Exp $
33

44
Postgres integrated documentation.
55
Other subset docs should be copied and shrunk from here.
66
thomas 1998-02-23
77

88
$Log: postgres.sgml,v $
9+
Revision 1.11 1998/10/25 00:24:31 thomas
10+
Add Y2K statement for intros.
11+
Make sure notation section is included in most intros.
12+
913
Revision 1.10 1998/10/21 05:31:52 thomas
1014
Include new information from Massimo. Rearrange ODBC docs.
1115

@@ -32,6 +36,7 @@ Include new chapters.
3236
<!entity info SYSTEM "info.sgml">
3337
<!entity legal SYSTEM "legal.sgml">
3438
<!entity notation SYSTEM "notation.sgml">
39+
<!entity y2k SYSTEM "y2k.sgml">
3540

3641
<!-- tutorial -->
3742
<!entity intro SYSTEM "intro.sgml">
@@ -221,6 +226,7 @@ Installation and maintenance information.
221226
&intro-ag;
222227
&ports;
223228
&install;
229+
&runtime;
224230
&options;
225231
&start-ag;
226232
&recovery;

‎doc/src/sgml/programmer.sgml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ $log$
1616
<!entity info SYSTEM "info.sgml">
1717
<!entity legal SYSTEM "legal.sgml">
1818
<!entity notation SYSTEM "notation.sgml">
19+
<!entity y2k SYSTEM "y2k.sgml">
1920

2021
<!entity arch SYSTEM "arch.sgml">
2122
<!entity start SYSTEM "start.sgml">
@@ -152,6 +153,7 @@ It provides SQL92/SQL3 language support,
152153
&xaggr;
153154
&rules;
154155
&xindex;
156+
&xplang;
155157
&gist;
156158
&dfunc;
157159

@@ -167,11 +169,19 @@ It provides SQL92/SQL3 language support,
167169
&ecpg;
168170
&odbc;
169171
&jdbc;
170-
&xplang;
171172

172173
<!-- development -->
173174

174-
&arch-dev;
175+
<!--
176+
The arch-dev chapter is current almost identical
177+
to the arch-pg chapter appearing earlier in the
178+
Programmer's Guide. If the Developer's Guide is
179+
split into a separate document the start using this
180+
again.
181+
- thomas 1998-10-23
182+
&arch-dev;
183+
-->
184+
175185
&geqo;
176186
&protocol;
177187
&signals;

‎doc/src/sgml/y2k.sgml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<sect1>
2+
<title>Y2K Statement</title>
3+
4+
<para>
5+
<note>
6+
<title>Author</title>
7+
8+
<para>
9+
Written by
10+
<ulink url="mailto:lockhart@alumni.caltech.edu">Thomas Lockhart</ulink>
11+
on 1998-10-22.
12+
</note>
13+
14+
<para>
15+
The <productname>PostgreSQL</productname> Global Development Team provides
16+
the <productname>Postgres</productname> software code tree as a public service,
17+
without warranty and without liability for it's behavior or performance.
18+
However, at the time of writing:
19+
20+
<itemizedlist>
21+
<listitem>
22+
<para>
23+
The author of this statement, a volunteer on the <productname>Postgres</productname>
24+
support team since November, 1996, is not aware of
25+
any problems in the <productname>Postgres</productname> code base related
26+
to time transitions around Jan 1, 2000 (Y2K).
27+
28+
<listitem>
29+
<para>
30+
The author of this statement is not aware of any reports of Y2K problems
31+
uncovered in regression testing
32+
or in other field use of recent or current versions
33+
of <productname>Postgres</productname>. We might have expected
34+
to hear about problems if they existed, given the installed base and
35+
the active participation of users on the support mailing lists.
36+
37+
<listitem>
38+
<para>
39+
To the best of the author's knowledge, the
40+
assumptions Postgres makes about dates specified with a two-digit year
41+
are documented in the current
42+
<ulink url="http://www.postgresql.org/docs/user/datatype.htm">User's Guide</ulink>
43+
in the chapter on data types.
44+
For two-digit years, the significant transition year is 1970, not 2000;
45+
i.e. <quote>70-01-01</quote> is interpreted as <quote>1970-01-01</quote>,
46+
whereas <quote>69-01-01</quote> is interpreted as <quote>2069-01-01</quote>.
47+
48+
<listitem>
49+
<para>
50+
Any Y2K problems in the underlying OS related to obtaining "the
51+
current time" may propagate into apparent Y2K problems in
52+
<productname>Postgres</productname>.
53+
54+
</itemizedlist>
55+
56+
<para>
57+
Refer to
58+
<ulink url="http://www.gnu.org/software/year2000.html">The Gnu Project</ulink>
59+
and
60+
<ulink url="http://language.perl.com/news/y2k.html">The Perl Institute</ulink>
61+
for further discussion of Y2K issues, particularly
62+
as it relates to open source, no fee software.
63+
64+
</sect1>

0 commit comments

Comments
 (0)