Document that PGDATA has to point to the configuration files, rather

bmomjian · bmomjian · commit 077908aed726 · 2012-08-15T22:59:37.000-04:00
than the actual data storage directory.

Per suggestion from Thom Brown
diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml
@@ -261,7 +261,7 @@ PostgreSQL documentation
       <term><option>--pgdata <replaceable class="parameter">datadir</replaceable></option></term>
       <listitem>
        <para>
-        Specifies the file system location of the database files.  If
+        Specifies the file system location of the database configuration files.  If
         this is omitted, the environment variable
         <envar>PGDATA</envar> is used.
        </para>
diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml
@@ -179,8 +179,8 @@ PostgreSQL documentation
       <term><option>-D <replaceable class="parameter">datadir</replaceable></option></term>
       <listitem>
        <para>
-        Specifies the file system location of the data directory or
-        configuration file(s).  See
+        Specifies the file system location of the database
+        configuration files.  See
         <xref linkend="runtime-config-file-locations"> for details.
        </para>
       </listitem>
diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml
@@ -19,7 +19,8 @@ directories.
 </para>
 
 <para>
-All the data needed for a database cluster is stored within the cluster's data
+Traditionally, the configuration and data files used by a database
+cluster are stored together within the cluster's data
 directory, commonly referred to as <varname>PGDATA</> (after the name of the
 environment variable that can be used to define it).  A common location for
 <varname>PGDATA</> is <filename>/var/lib/pgsql/data</>.  Multiple clusters,
@@ -33,7 +34,7 @@ these required items, the cluster configuration files
 <filename>postgresql.conf</filename>, <filename>pg_hba.conf</filename>, and
 <filename>pg_ident.conf</filename> are traditionally stored in
 <varname>PGDATA</> (although in <productname>PostgreSQL</productname> 8.0 and
-later, it is possible to keep them elsewhere).
+later, it is possible to place them elsewhere).
 </para>
 
 <table tocentry="1" id="pgdata-contents-table">
