Add Y2K statement for intros.

Make sure notation section is included in most intros.

diff --git a/doc/src/sgml/admin.sgml b/doc/src/sgml/admin.sgml
index 31c026d27a87694cf081650d83d2ba93100897ec..c2da76e1961ec95db0a5b1aec78fb0c8addee507 100644 (file)
--- a/doc/src/sgml/admin.sgml
+++ b/doc/src/sgml/admin.sgml
@@ -16,6 +16,7 @@ $log$
 <!entity info     SYSTEM "info.sgml">
 <!entity legal    SYSTEM "legal.sgml">
 <!entity notation SYSTEM "notation.sgml">
+<!entity y2k      SYSTEM "y2k.sgml">
 
 <!entity intro-ag SYSTEM "intro-ag.sgml">
 <!entity install  SYSTEM "install.sgml">

diff --git a/doc/src/sgml/intro-ag.sgml b/doc/src/sgml/intro-ag.sgml
index d54187b72bb469756a03592fa93d75b70694b0fd..9693d3a68ededaf00057b9c3e97aebe9461e4e7e 100644 (file)
--- a/doc/src/sgml/intro-ag.sgml
+++ b/doc/src/sgml/intro-ag.sgml
@@ -17,8 +17,12 @@ The <ProductName>Postgres</ProductName> project,
      Foundation (<Acronym>NSF</Acronym>), and ESL, Inc.
 </Para>
 
+&info;
+
 &notation;
 
+&y2k;
+
 &legal;
 
 </Chapter>

diff --git a/doc/src/sgml/intro-pg.sgml b/doc/src/sgml/intro-pg.sgml
index cd9b98073f9786bed32159c1a4b8a19ca3076d99..98b16b1601e362d01aa84ca9e3bb49a4ddaf1541 100644 (file)
--- a/doc/src/sgml/intro-pg.sgml
+++ b/doc/src/sgml/intro-pg.sgml
@@ -2,10 +2,10 @@
 <TITLE>Introduction</TITLE>
 
 <Para>
-     This document is the programmer's  manual  for  the  
-     <Ulink url="http://postgresql.org/"><ProductName>PostgreSQL</ProductName></Ulink>
-     database  management system, originally developed at the University
-     of California at  Berkeley.
+This document is the programmer's  manual  for  the  
+<Ulink url="http://postgresql.org/"><ProductName>PostgreSQL</ProductName></Ulink>
+database  management system, originally developed at the University
+of California at Berkeley.
 
 <ProductName>PostgreSQL</ProductName>  is  based  on
      <Ulink url="http://s2k-ftp.CS.Berkeley.EDU:8000/postgres/postgres.html">
@@ -18,16 +18,16 @@ The <ProductName>Postgres</ProductName> project,
 </Para>
 
 <Para>
-     The first part of this manual 
-     explains  the <ProductName>Postgres</ProductName>  
+The first part of this manual 
+explains  the <ProductName>Postgres</ProductName>  
 approach  to  extensibility  and describe how
-     users can extend <ProductName>Postgres</ProductName> 
+users can extend <ProductName>Postgres</ProductName> 
 by adding user-defined types,
-     operators, aggregates, and both query language and programming 
+operators, aggregates, and both query language and programming 
 language functions.
-     After an extremely  brief
-     overview  of  the <ProductName>Postgres</ProductName> rule system, we discuss
-     the trigger and SPI interfaces.
+     After a discussion  of  the <ProductName>Postgres</ProductName> 
+rule system, we discuss
+the trigger and SPI interfaces.
      The manual concludes with a detailed description of 
 the programming interfaces and
      support libraries for various languages.
@@ -37,8 +37,12 @@ the programming interfaces and
      We assume proficiency with UNIX and C programming.
 </Para>
 
+&info;
+
 &notation;
 
+&y2k;
+
 &legal;
 
 </Chapter>

diff --git a/doc/src/sgml/intro.sgml b/doc/src/sgml/intro.sgml
index b777099bcf3166298a22887d0bd1929e1e2e3815..e283a5e5b8928ac0de5b88e05189ea75eb4572e6 100644 (file)
--- a/doc/src/sgml/intro.sgml
+++ b/doc/src/sgml/intro.sgml
@@ -74,6 +74,10 @@ have recently incorporated features pioneered by <ProductName>Postgres</ProductN
 
 &info;
 
+&notation;
+
+&y2k;
+
 &legal;
 
 </Chapter>

diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml
index f31a9c0858368f572534026f521cb9097eab6557..5bde955945139b35ce44186084fc645553e6fb99 100644 (file)
--- a/doc/src/sgml/notation.sgml
+++ b/doc/src/sgml/notation.sgml
@@ -14,22 +14,23 @@ particular set of installed
 
 <para>
 The 
-<Productname>Postgres</Productname> <firstterm>super-user</firstterm>
+<Productname>Postgres</Productname> <firstterm>superuser</firstterm>
 is the user named <replaceable>postgres</replaceable>
  who owns the <Productname>Postgres</Productname>
-binaries and database files.  As the database super-user, all
+binaries and database files.  As the database superuser, all
 protection mechanisms may be bypassed and any data accessed
 arbitrarily.  
-In addition, the <Productname>Postgres</Productname> super-user is allowed to execute
+In addition, the <Productname>Postgres</Productname> superuser is allowed to execute
 some support programs which are generally not available to all users.
-Note that the <Productname>Postgres</Productname> super-user is
+Note that the <Productname>Postgres</Productname> superuser is
 <emphasis>not</emphasis>
-the same as the Unix super-user (<literal>root</literal>),
-and should have a non-zero userid for security reasons.
+the same as the Unix superuser (which will be referred to as <firstterm>root</firstterm>).
+The superuser should have a non-zero user identifier (<firstterm>UID</firstterm>)
+for security reasons.
 
 <para>
 The
-<firstterm>database base administrator</firstterm>
+<firstterm>database administrator</firstterm>
 or <acronym>DBA</acronym>, is the person who is responsible for installing 
 <Productname>Postgres</Productname> with mechanisms to
 enforce a security policy for a site.  The DBA can add new users by
@@ -62,12 +63,34 @@ site.
 <title>Notation</title>
 
 <para>
-<quote>...</quote> at the front of a file name is used to represent the
-path to the <Productname>Postgres</Productname> super-user's home directory.  
-Anything in brackets
-<quote>[</quote> and <quote>]</quote>) is optional.  Anything in braces
-(<quote>{</quote> and <quote>}</quote>) can be repeated 0 or more times.
-Parentheses (<quote>(</quote> and <quote>)</quote>) are used to group boolean
+<quote>...</quote> or <filename>/usr/local/pgsql/<filename> 
+at the front of a file name is used to represent the
+path to the <Productname>Postgres</Productname> superuser's home directory.
+
+<para>
+In a command synopsis, brackets
+<quote>[</quote> and <quote>]</quote>) indicate an optional phrase or keyword.
+Anything in braces
+(<quote>{</quote> and <quote>}</quote>) and containing vertical bars (<quote>|</quote>)
+ indicates that you must choose one.
+
+<para>
+In examples, parentheses (<quote>(</quote> and <quote>)</quote>) are used to group boolean
 expressions.  <quote>|</quote> is the boolean operator OR.
 
-</sect1>
\ No newline at end of file
+<para>
+Examples will show commands executed from various accounts and programs.
+Commands executed from the root account will be preceeded with <quote>&gt;</quote>.
+Commands executed from the superuser account will be preceeded with <quote>$</quote>.
+<acronym>SQL</acronym> commands will be preceeded with <quote>=&gt;</quote>
+or will have no leading prompt.
+
+<note>
+<para>
+At the time of writing (<Productname>Postgres</Productname> v6.4) the notation for
+flagging commands is not universally consistant throughout the documentation set.
+Please report problems to
+<ulink url="mailto:docs@postgresql.org">the Documentation Mailing List</ulink>.
+</note>
+
+</sect1>

diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml
index f5e35668bbdb49b26dea58b7bd75310d4491e4c2..b17691465ef01016be4a17afc33aa650201d1fe7 100644 (file)
--- a/doc/src/sgml/postgres.sgml
+++ b/doc/src/sgml/postgres.sgml
@@ -1,11 +1,15 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.10 1998/10/21 05:31:52 thomas Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.11 1998/10/25 00:24:31 thomas Exp $
 
 Postgres integrated documentation.
 Other subset docs should be copied and shrunk from here.
 thomas 1998-02-23
 
 $Log: postgres.sgml,v $
+Revision 1.11  1998/10/25 00:24:31  thomas
+Add Y2K statement for intros.
+Make sure notation section is included in most intros.
+
 Revision 1.10  1998/10/21 05:31:52  thomas
 Include new information from Massimo. Rearrange ODBC docs.
 
@@ -32,6 +36,7 @@ Include new chapters.
 <!entity info     SYSTEM "info.sgml">
 <!entity legal    SYSTEM "legal.sgml">
 <!entity notation SYSTEM "notation.sgml">
+<!entity y2k      SYSTEM "y2k.sgml">
 
 <!-- tutorial -->
 <!entity intro    SYSTEM "intro.sgml">
@@ -221,6 +226,7 @@ Installation and maintenance information.
 &intro-ag;
 &ports;
 &install;
+&runtime;
 &options;
 &start-ag;
 &recovery;

diff --git a/doc/src/sgml/programmer.sgml b/doc/src/sgml/programmer.sgml
index 7f62767ef5f589a28a09758dea04496e4919c4ba..060066dc3bcd9a542c9117060f8e3de5c65da198 100644 (file)
--- a/doc/src/sgml/programmer.sgml
+++ b/doc/src/sgml/programmer.sgml
@@ -16,6 +16,7 @@ $log$
 <!entity info     SYSTEM "info.sgml">
 <!entity legal    SYSTEM "legal.sgml">
 <!entity notation SYSTEM "notation.sgml">
+<!entity y2k      SYSTEM "y2k.sgml">
 
 <!entity arch     SYSTEM "arch.sgml">
 <!entity start    SYSTEM "start.sgml">
@@ -152,6 +153,7 @@ It provides SQL92/SQL3 language support,
 &xaggr;
 &rules;
 &xindex;
+&xplang;
 &gist;
 &dfunc;
 
@@ -167,11 +169,19 @@ It provides SQL92/SQL3 language support,
 &ecpg;
 &odbc;
 &jdbc;
-&xplang;
 
 <!-- development -->
 
-&arch-dev;
+<!--
+The arch-dev chapter is current almost identical 
+to the arch-pg chapter appearing earlier in the
+Programmer's Guide. If the Developer's Guide is
+split into a separate document the start using this
+again.
+- thomas 1998-10-23
+&arch-dev; 
+-->
+
 &geqo;
 &protocol;
 &signals;

diff --git a/doc/src/sgml/y2k.sgml b/doc/src/sgml/y2k.sgml
new file mode 100644 (file)
index 0000000..a2d9f2e
--- /dev/null
+++ b/doc/src/sgml/y2k.sgml
@@ -0,0 +1,64 @@
+<sect1>
+<title>Y2K Statement</title>
+
+<para>
+<note>
+<title>Author</title>
+
+<para>
+Written by 
+<ulink url="mailto:lockhart@alumni.caltech.edu">Thomas Lockhart</ulink>
+on 1998-10-22.
+</note>
+
+<para>
+The <productname>PostgreSQL</productname> Global Development Team provides
+the <productname>Postgres</productname> software code tree as a public service,
+without warranty and without liability for it's behavior or performance.
+However, at the time of writing:
+
+<itemizedlist>
+<listitem>
+<para>
+The author of this statement, a volunteer on the <productname>Postgres</productname>
+ support team since November, 1996, is not aware of 
+any problems in the <productname>Postgres</productname> code base related
+to time transitions around Jan 1, 2000 (Y2K).
+
+<listitem>
+<para>
+The author of this statement is not aware of any reports of Y2K problems 
+uncovered in regression testing
+or in other field use of recent or current versions
+of <productname>Postgres</productname>. We might have expected
+to hear about problems if they existed, given the installed base and
+the active participation of users on the support mailing lists.
+
+<listitem>
+<para>
+To the best of the author's knowledge, the
+assumptions Postgres makes about dates specified with a two-digit year
+are documented in the current 
+<ulink url="http://www.postgresql.org/docs/user/datatype.htm">User's Guide</ulink>
+ in the chapter on data types.
+For two-digit years, the significant transition year is 1970, not 2000;
+i.e. <quote>70-01-01</quote> is interpreted as <quote>1970-01-01</quote>,
+whereas <quote>69-01-01</quote> is interpreted as <quote>2069-01-01</quote>.
+
+<listitem>
+<para>
+Any Y2K problems in the underlying OS related to obtaining "the
+current time" may propagate into apparent Y2K problems in
+<productname>Postgres</productname>.
+
+</itemizedlist>
+
+<para>
+Refer to 
+<ulink url="http://www.gnu.org/software/year2000.html">The Gnu Project</ulink>
+and
+<ulink url="http://language.perl.com/news/y2k.html">The Perl Institute</ulink>
+for further discussion of Y2K issues, particularly
+ as it relates to open source, no fee software.
+
+</sect1>
\ No newline at end of file