public inbox for [email protected]
help / color / mirror / Atom feedDocumentation cross reference from copy to \copy
2+ messages / 2 participants
[nested] [flat]
* Documentation cross reference from copy to \copy
@ 2012-08-10 16:24 Jeff Janes <[email protected]>
0 siblings, 1 reply; 2+ messages in thread
From: Jeff Janes @ 2012-08-10 16:24 UTC (permalink / raw)
To: pgsql-docs
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=>
*** 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 }
^ permalink raw reply [nested|flat] 2+ messages in thread
* Re: Documentation cross reference from copy to \copy
@ 2012-08-11 17:49 Tom Lane <[email protected]>
parent: Jeff Janes <[email protected]>
0 siblings, 0 replies; 2+ messages in thread
From: Tom Lane @ 2012-08-11 17:49 UTC (permalink / raw)
To: Jeff Janes <[email protected]>; +Cc: pgsql-docs
Jeff Janes <[email protected]> writes:
> 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.
It seems reasonable from here. I thought at first that it might break
the man-page output, but AFAICT there is no effect on that.
regards, tom lane
^ permalink raw reply [nested|flat] 2+ messages in thread
end of thread, other threads:[~2012-08-11 17:49 UTC | newest]
Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2012-08-10 16:24 Documentation cross reference from copy to \copy Jeff Janes <[email protected]>
2012-08-11 17:49 ` Tom Lane <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox