Re: Repost: Linking references in documentation - Mailing list pgsql-patches

Michael Glaesemann <grzm@myrealbox.com> writes:
> Below is a patch to provide a few links between the former
> administrator's guide and appropriate reference pages.

Patch applied, with some additional changes in the same vein. The
actual patch I applied is attached.

Thanks for the patch.

-Neil

Index: doc/src/sgml/backup.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/backup.sgml,v
retrieving revision 2.35
diff -c -r2.35 backup.sgml
*** a/doc/src/sgml/backup.sgml    3 Feb 2004 17:34:02 -0000    2.35
--- b/doc/src/sgml/backup.sgml    17 Feb 2004 08:49:05 -0000
***************
*** 86,94 ****
      When your database schema relies on OIDs (for instance as foreign
      keys) you must instruct <application>pg_dump</> to dump the OIDs
      as well. To do this, use the <option>-o</option> command line
!     option.  <quote>Large objects</> are not dumped by default, either.
!     See <application>pg_dump</>'s command reference page if you use
!     large objects.
     </para>
    </important>

--- 86,94 ----
      When your database schema relies on OIDs (for instance as foreign
      keys) you must instruct <application>pg_dump</> to dump the OIDs
      as well. To do this, use the <option>-o</option> command line
!     option.  <quote>Large objects</> are not dumped by default,
!     either.  See <xref linkend="app-pgdump">'s reference page if you
!     use large objects.
     </para>
    </important>

***************
*** 260,266 ****
  pg_dump -Fc <replaceable class="parameter">dbname</replaceable> > <replaceable
class="parameter">filename</replaceable>
  </programlisting>

!      See the <application>pg_dump</> and <application>pg_restore</> reference pages for details.
      </para>
     </formalpara>

--- 260,267 ----
  pg_dump -Fc <replaceable class="parameter">dbname</replaceable> > <replaceable
class="parameter">filename</replaceable>
  </programlisting>

!      See the <xref linkend="app-pgdump"> and <xref
!      linkend="app-pgrestore"> reference pages for details.
      </para>
     </formalpara>

***************
*** 298,305 ****
     </para>

     <para>
!     Please familiarize yourself with the
!     <citerefentry><refentrytitle>pg_dump</></> reference page.
     </para>
    </sect2>
   </sect1>
--- 299,306 ----
     </para>

     <para>
!     Please familiarize yourself with the <xref linkend="app-pgdump">
!     reference page.
     </para>
    </sect2>
   </sect1>
Index: doc/src/sgml/user-manag.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/user-manag.sgml,v
retrieving revision 1.24
diff -c -r1.24 user-manag.sgml
*** a/doc/src/sgml/user-manag.sgml    29 Nov 2003 19:51:38 -0000    1.24
--- b/doc/src/sgml/user-manag.sgml    17 Feb 2004 08:55:14 -0000
***************
*** 161,168 ****

      A user's attributes can be modified after creation with
      <command>ALTER USER</command>.<indexterm><primary>ALTER USER</></>
!     See the reference pages for <command>CREATE USER</command> and
!     <command>ALTER USER</command> for details.
     </para>

    <para>
--- 161,169 ----

      A user's attributes can be modified after creation with
      <command>ALTER USER</command>.<indexterm><primary>ALTER USER</></>
!     See the reference pages for the <xref linkend="sql-createuser"
!     endterm="sql-createuser-title"> and <xref linkend="sql-alteruser"
!     endterm="sql-alteruser-title"> commands for details.
     </para>

    <para>
Index: doc/src/sgml/ref/pg_restore.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/ref/pg_restore.sgml,v
retrieving revision 1.45
diff -c -r1.45 pg_restore.sgml
*** a/doc/src/sgml/ref/pg_restore.sgml    6 Dec 2003 03:00:10 -0000    1.45
--- b/doc/src/sgml/ref/pg_restore.sgml    17 Feb 2004 08:36:53 -0000
***************
*** 110,116 ****
         <para>
          Create the database before restoring into it.  (When this
          option is used, the database named with <option>-d</option> is
!         used only to issue the initial <literal>CREATE DATABASE</>
          command.  All data is restored into the database name that
          appears in the archive.)
         </para>
--- 110,116 ----
         <para>
          Create the database before restoring into it.  (When this
          option is used, the database named with <option>-d</option> is
!         used only to issue the initial <command>CREATE DATABASE</>
          command.  All data is restored into the database name that
          appears in the archive.)
         </para>
***************
*** 454,460 ****
     internally executes <acronym>SQL</acronym> statements. If you have
     problems running <application>pg_restore</application>, make sure
     you are able to select information from the database using, for
!    example, <application>psql</application>.
    </para>
   </refsect1>

--- 454,460 ----
     internally executes <acronym>SQL</acronym> statements. If you have
     problems running <application>pg_restore</application>, make sure
     you are able to select information from the database using, for
!    example, <xref linkend="app-psql">.
    </para>
   </refsect1>