Re: confusing archive_command example - Mailing list pgsql-docs
From | Bruce Momjian |
---|---|
Subject | Re: confusing archive_command example |
Date | |
Msg-id | 201004122205.o3CM5vc27021@momjian.us Whole thread Raw |
In response to | Re: confusing archive_command example (Greg Smith <greg@2ndquadrant.com>) |
List | pgsql-docs |
Greg Smith wrote: > The third issue here, not mentioned yet, is that there's also an example > of setting up archive_command in its GUC documentation: > > http://developer.postgresql.org/pgdocs/postgres/runtime-config-wal.html > > This has drifted out of sync with the section being updated here this > week--its archive_command example isn't even using "-i". I think the > right thing to do here is to migrate the Windows example out of 18.5.3 > from 24.3.1, then replace the existing examples in 18.5.3 to instead > suggest 24.3.1 has them. Given that all of this documentation giving > examples for how to correctly configure that parameter, like this cp > trivia, only appears in the PITR docs section, I don't see any reason to > duplicate that in the GUC area. Having the second, minimally documented > version of those in 18.5.3 just encourages people to use what we know is > a bad practice by providing them as examples. Agreed. The attached applied patch removes the example from the configure section. -- Bruce Momjian <bruce@momjian.us> http://momjian.us EnterpriseDB http://enterprisedb.com Index: doc/src/sgml/config.sgml =================================================================== RCS file: /cvsroot/pgsql/doc/src/sgml/config.sgml,v retrieving revision 1.262 diff -c -c -r1.262 config.sgml *** doc/src/sgml/config.sgml 3 Apr 2010 07:22:53 -0000 1.262 --- doc/src/sgml/config.sgml 12 Apr 2010 21:59:26 -0000 *************** *** 1721,1728 **** (The path name is relative to the working directory of the server, i.e., the cluster's data directory.) Use <literal>%%</> to embed an actual <literal>%</> character in the ! command. For more information see <xref ! linkend="backup-archiving-wal">. This parameter can only be set in the <filename>postgresql.conf</> file or on the server command line. It is ignored unless <varname>archive_mode</> was enabled at server start. --- 1721,1731 ---- (The path name is relative to the working directory of the server, i.e., the cluster's data directory.) Use <literal>%%</> to embed an actual <literal>%</> character in the ! command. It is important for the command to return a zero ! exit status only if it succeeds. For more information see ! <xref linkend="backup-archiving-wal">. ! </para> ! <para> This parameter can only be set in the <filename>postgresql.conf</> file or on the server command line. It is ignored unless <varname>archive_mode</> was enabled at server start. *************** *** 1735,1748 **** archiving, but also breaks the chain of WAL files needed for archive recovery, so it should only be used in unusual circumstances. </para> - <para> - It is important for the command to return a zero exit status if - and only if it succeeds. Examples: - <programlisting> - archive_command = 'cp "%p" /mnt/server/archivedir/"%f"' - archive_command = 'copy "%p" "C:\\server\\archivedir\\%f"' # Windows - </programlisting> - </para> </listitem> </varlistentry> --- 1738,1743 ----
pgsql-docs by date: