public inbox for [email protected]  
help / color / mirror / Atom feed
From: Jeff Janes <[email protected]>
To: [email protected]
Subject: Documentation cross reference from copy to \copy
Date: Fri, 10 Aug 2012 09:24:06 -0700
Message-ID: <CAMkU=1wYJhQT0rrDYmGXJNEQgMG9SxXDG1rFRDuhnYxLYDnskw@mail.gmail.com> (raw)

Where the SQL COPY command warns us not to confuse it with \copy, a
link to \copy would be useful.  The attached patch implements that,
but I'm not sure it does so in the preferred way.

Thanks,

Jeff


Attachments:

  [application/octet-stream] copy_crossref_v1.patch (2.2K, 2-copy_crossref_v1.patch)
  download | inline diff:
diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml
new file mode 100644
index 4e4e834..e5f45f4
*** a/doc/src/sgml/ref/copy.sgml
--- b/doc/src/sgml/ref/copy.sgml
*************** COPY <replaceable class="parameter">coun
*** 353,359 ****
     <para>
      Do not confuse <command>COPY</command> with the
      <application>psql</application> instruction
!     <command>\copy</command>. <command>\copy</command> invokes
      <command>COPY FROM STDIN</command> or <command>COPY TO
      STDOUT</command>, and then fetches/stores the data in a file
      accessible to the <application>psql</application> client. Thus,
--- 353,359 ----
     <para>
      Do not confuse <command>COPY</command> with the
      <application>psql</application> instruction
!     <command><link linkend="APP-PSQL-meta-commands-copy">\copy</link></command>. <command>\copy</command> invokes
      <command>COPY FROM STDIN</command> or <command>COPY TO
      STDOUT</command>, and then fetches/stores the data in a file
      accessible to the <application>psql</application> client. Thus,
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
new file mode 100644
index 1ba5ea8..6d8f2cc
*** a/doc/src/sgml/ref/psql-ref.sgml
--- b/doc/src/sgml/ref/psql-ref.sgml
*************** testdb=&gt;
*** 826,832 ****
          </listitem>
        </varlistentry>
  
!       <varlistentry>
          <term><literal>\copy { <replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column_list</replaceable> ) ] | ( <replaceable class="parameter">query</replaceable> ) }
          { <literal>from</literal> | <literal>to</literal> }
          { <replaceable class="parameter">filename</replaceable> | stdin | stdout | pstdin | pstdout }
--- 826,832 ----
          </listitem>
        </varlistentry>
  
!       <varlistentry id="APP-PSQL-meta-commands-copy">
          <term><literal>\copy { <replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column_list</replaceable> ) ] | ( <replaceable class="parameter">query</replaceable> ) }
          { <literal>from</literal> | <literal>to</literal> }
          { <replaceable class="parameter">filename</replaceable> | stdin | stdout | pstdin | pstdout }


view thread (2+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: Documentation cross reference from copy to \copy
  In-Reply-To: <CAMkU=1wYJhQT0rrDYmGXJNEQgMG9SxXDG1rFRDuhnYxLYDnskw@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox