8000 Remove a bunch of antique information from the appendix in the docs · postgrespro/postgres_cluster@be4dbd9 · GitHub
[go: up one dir, main page]
Skip to content

Commit be4dbd9

Browse files
author
Neil Conway
committed
Remove a bunch of antique information from the appendix in the docs
that discusses CVS. Remove the recommendation to use cvs 1.10. Remove discussion of alleged CVSup binaries on postgresql.org, because they have not existed for several years. Remove discussion of how to build cvsup from source because the existing text is outdated, and more accurate information is available from the CVSup homepage.
1 parent 58a7efa commit be4dbd9

File tree

1 file changed

+12
-246
lines changed

1 file changed

+12
-246
lines changed

‎doc/src/sgml/cvs.sgml

Lines changed: 12 additions & 246 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/cvs.sgml,v 1.38 2006/10/23 18:10:30 petere Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/cvs.sgml,v 1.39 2006/11/17 05:29:46 neilc Exp $ -->
22

33
<appendix id="cvs">
44
<appendixinfo>
@@ -23,7 +23,7 @@
2323

2424
<para>
2525
The <productname>PostgreSQL</productname> source code is stored and managed using the
26-
<productname>CVS</productname> code management system.
26+
<productname>CVS</productname> version control system.
2727
</para>
2828

2929
<para>
@@ -50,10 +50,9 @@
5050
<para>
5151
You will need a local copy of <productname>CVS</productname>
5252
(Concurrent Version Control System), which you can get from
53-
<ulink url="http://www.nongnu.org/cvs/"></ulink>
54-
(the official site with the latest version) or any GNU software
55-
archive site (often somewhat outdated). We recommend version 1.10
56-
or newer. Many systems have a recent version of
53+
<ulink url="http://www.nongnu.org/cvs/"></ulink> (the official
54+
site with the latest version) or any GNU software archive site
55+
(often somewhat outdated). Many systems have a recent version of
5756
<application>cvs</application> installed by default.
5857
</para>
5958
</step>
@@ -72,7 +71,7 @@ cvs -d :pserver:anoncvs@anoncvs.postgresql.org:/projects/cvsroot login
7271

7372
<para>
7473
You should only need to do this once, since the password will be
75-
saved in <literal>.cvspass</literal> in your home directory.
74+
saved in <filename>.cvspass</filename> in your home directory.
7675
</para>
7776
</step>
7877

@@ -143,29 +142,13 @@ cvs update
143142
</step>
144143
</procedure>
145144

146-
<caution>
147-
<para>
148-
Some older versions of <productname>CVS</productname> have a bug that
149-
causes all checked-out files to be stored world-writable in your
150-
directory. If you see that this has happened, you can do something like
151-
<programlisting>
152-
chmod -R go-w pgsql
153-
</programlisting>
154-
to set the permissions properly.
155-
This bug is fixed as of
156-
<productname>CVS</productname> version 1.9.28.
157-
</para>
158-
</caution>
159-
160145
<para>
161-
<productname>CVS</productname> can do a lot of other things,
162-
such as fetching prior revisions
163-
of the <productname>PostgreSQL</productname> sources
164-
rather than the latest development version.
165-
For more info consult the manual that comes with
166-
<productname>CVS</productname>, or see the online
167-
documentation at
168-
<ulink url="http://www.nongnu.org/cvs/"></ulink>.
146+
<productname>CVS</productname> can do a lot of other things, such
147+
as fetching prior revisions of the
148+
<productname>PostgreSQL</productname> sources rather than the
149+
latest development version. For more info consult the manual that
150+
comes with <productname>CVS</productname>, or see the online
151+
documentation at <ulink url="http://www.nongnu.org/cvs/"></ulink>.
169152
</para>
170153
</sect1>
171154

@@ -478,222 +461,5 @@ pgsql
478461
</programlisting>
479462
</para>
480463
</sect2>
481-
482-
<sect2>
483-
<title>Installing <productname>CVSup</productname></title>
484-
485-
<para>
486-
<productname>CVSup</productname> is available as source, pre-built
487-
binaries, or Linux RPMs. It is far easier to use a binary than to
488-
build from source, primarily because the very capable, but
489-
voluminous, Modula-3 compiler is required for the build.
490-
</para>
491-
492-
<procedure>
493-
<title><productname>CVSup</productname> Installation from Binaries</title>
494-
495-
<para>
496-
You can use pre-built binaries
497-
if you have a platform for which binaries
498-
are posted on the <productname>PostgreSQL</productname>
499-
<ulink url="ftp://ftp.postgresql.org/pub">
500-
ftp site</ulink>
501-
or if you are running FreeBSD, for which
502-
<productname>CVSup</productname> is available as a port.
503-
504-
<note>
505-
<para>
506-
<productname>CVSup</productname> was originally developed as a
507-
tool for distributing the <productname>FreeBSD</productname>
508-
source tree. It is available as a <quote>port</quote>, and for those running
509-
FreeBSD, if this is not sufficient to tell how to obtain and
510-
install it then please contribute a procedure here.
511-
</para>
512-
</note>
513-
</para>
514-
515-
<para>
516-
At the time of writing, binaries are available for
517-
Alpha/Tru64, ix86/xBSD,
518-
HPPA/HP-UX 10.20, MIPS/IRIX,
519-
ix86/linux-libc5, ix86/linux-glibc,
520-
Sparc/Solaris, and Sparc/SunOS.
521-
</para>
522-
523-
<step>
524-
<para>
525-
Retrieve the binary tar file for
526-
<application>cvsup</application>
527-
(<application>cvsupd</application> is not required
528-
to be a client) appropriate for your platform.
529-
</para>
530-
531-
<substeps>
532-
<step performance="optional">
533-
<para>
534-
If you are running FreeBSD, install the <productname>CVSup</productname> port.
535-
</para>
536-
</step>
537-
538-
<step performance="optional">
539-
<para>
540-
If you have another platform, check for and download the appropriate binary from
541-
the <productname>PostgreSQL</productname>
542-
<ulink url="ftp://ftp.postgresql.org/pub">
543-
ftp site</ulink>.
544-
</para>
545-
</step>
546-
</substeps>
547-
</step>
548-
549-
<step>
550-
<para>
551-
Check the tar file to verify the contents and directory
552-
structure, if any. For the linux tar file at least, the static binary
553-
and man page is included without any directory packaging.
554-
</para>
555-
556-
<substeps>
557-
<step>
558-
<para>
559-
If the binary is in the top level of the tar file, then simply
560-
unpack the tar file into your target directory:
561-
562-
<programlisting>
563-
cd /usr/local/bin
564-
tar zxvf /usr/local/src/cvsup-16.0-linux-i386.tar.gz
565-
mv cvsup.1 ../doc/man/man1/
566-
</programlisting>
567-
</para>
568-
</step>
569-
570-
<step>
571-
<para>
572-
If there is a directory structure in the tar file, then unpack
573-
the tar file within <filename>/usr/local/src</filename> and move the binaries into
574-
the appropriate location as above.
575-
</para>
576-
</step>
577-
</substeps>
578-
</step>
579-
580-
<step>
581-
<para>
582-
Ensure that the new binaries are in your path.
583-
584-
<programlisting>
585-
$ rehash
586-
$ which cvsup
587-
$ set path=(<replaceable>path to cvsup</replaceable> $path)
588-
$ which cvsup
589-
/usr/local/bin/cvsup
590-
</programlisting>
591-
</para>
592-
</step>
593-
</procedure>
594-
</sect2>
595-
596-
<sect2>
597-
<title>Installation from Sources</title>
598-
599-
<para>
600-
Installing <productname>CVSup</productname> from sources is not
601-
entirely trivial, primarily because most systems will need to
602-
install a Modula-3 compiler first.
603-
This compiler is available as Linux <productname>RPM</productname>,
604-
FreeBSD package, or source code.
605-
606-
<note>
607-
<para>
608-
A clean-source installation of Modula-3 takes roughly 200MB of disk space,
609-
which shrinks to roughly 50MB of space when the sources are removed.</para>
610-
</note>
611-
</para>
612-
613-
<procedure>
614-
<title>Linux installation</title>
615-
616-
<step>
617-
<para>
618-
Install Modula-3.
619-
</para>
620-
621-
<substeps>
622-
<step>
623-
<para>
624-
Pick up the <productname>Modula-3</productname>
625-
distribution from <ulink url="http://m3.polymtl.ca/m3">
626-
Polytechnique Montr�al</ulink>
627-
who are actively maintaining the code base originally developed by
628-
the <ulink url="http://www.research.digital.com/SRC/modula-3/html/home.html">
629-
DEC Systems Research Center</ulink>.
630-
The <productname>PM3</productname> <productname>RPM</productname> distribution is roughly
631-
30MB compressed. At the time of writing, the 1.1.10-1 release
632-
installed cleanly on RH-5.2, whereas the 1.1.11-1 release is
633-
apparently built for another release (RH-6.0?) and does not run on RH-5.2.
634-
635-
<tip>
636-
<para>
637-
This particular rpm packaging has
638-
<emphasis>many</emphasis> <productname>RPM</productname> files,
639-
so you will likely want to place them into a separate
640-
directory.
641-
</para>
642-
</tip>
643-
</para>
644-
</step>
645-
646-
<step>
647-
<para>
648-
Install the Modula-3 RPMs:
649-
650-
<programlisting>
651-
# rpm -Uvh pm3*.rpm
652-
</programlisting>
653-
</para>
654-
</step>
655-
</substeps>
656-
</step>
657-
658-
<step>
659-
<para>
660-
Unpack the cvsup distribution:
661-
662-
<programlisting>
663-
# cd /usr/local/src
664-
# tar zxf cvsup-16.0.tar.gz
665-
</programlisting>
666-
</para>
667-
</step>
668-
669-
<step>
670-
<para>
671-
Build the cvsup distribution, suppressing the GUI interface
672-
feature to avoid requiring X11 libraries:
673-
674-
<programlisting>
675-
# make M3FLAGS="-DNOGUI"
676-
</programlisting>
677-
678-
and if you want to build a static binary to move to systems
679-
that may not have Modula-3 installed, try:
680-
681-
<programlisting>
682-
# make M3FLAGS="-DNOGUI -DSTATIC"
683-
</programlisting>
684-
</para>
685-
</step>
686-
687-
<step>
688-
<para>
689-
Install the built binary:
690-
691-
<programlisting>
692-
# make M3FLAGS="-DNOGUI -DSTATIC" install
693-
</programlisting>
694-
</para>
695-
</step>
696-
</procedure>
697-
</sect2>
698464
</sect1>
699465
</appendix>

0 commit comments

Comments
 (0)
0