Thu Feb 28 10:54:31 2019 UTC ()
guide: Improve/extend documentation about FTP layout

 - Document the `current', `stable' and `pkgsrc-20xxQy' more extensively,
   from J. Lewis Muir via PR pkg/54019.  Thanks!
 - Refers to `pkgsrc.tar.{bz,gz,xz}' instead of just `pkgsrc.tar.gz' to
   cover all compressed formats.
 - Document `pkgsrc-readmes.tar.{bz,gz,xz}'


(leot)
diff -r1.14 -r1.15 pkgsrc/doc/guide/files/ftp-layout.xml
cvs diff -r1.14 -r1.15 pkgsrc/doc/guide/files/ftp-layout.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/ftp-layout.xml 2019/02/26 12:11:49 1.14
+++ pkgsrc/doc/guide/files/ftp-layout.xml 2019/02/28 10:54:31 1.15
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1<!-- $NetBSD: ftp-layout.xml,v 1.14 2019/02/26 12:11:49 leot Exp $ --> 1<!-- $NetBSD: ftp-layout.xml,v 1.15 2019/02/28 10:54:31 leot Exp $ -->
2 2
3<appendix id="ftp-layout"> 3<appendix id="ftp-layout">
4<title>Directory layout of the pkgsrc FTP server</title> 4<title>Directory layout of the pkgsrc FTP server</title>
5 5
6 <para>As in other big projects, the directory layout of pkgsrc 6 <para>As in other big projects, the directory layout of pkgsrc
7 is quite complex for newbies. This chapter explains where you 7 is quite complex for newbies. This chapter explains where you
8 find things on the FTP server. The base directory on 8 find things on the FTP server. The base directory on
9 <filename>ftp.NetBSD.org</filename> is <ulink 9 <filename>ftp.NetBSD.org</filename> is <ulink
10 url="ftp://ftp.NetBSD.org/pub/pkgsrc/"><filename>/pub/pkgsrc/</filename></ulink>. 10 url="ftp://ftp.NetBSD.org/pub/pkgsrc/"><filename>/pub/pkgsrc/</filename></ulink>.
11 On other servers it may be different, but inside this directory, 11 On other servers it may be different, but inside this directory,
12 everything should look the same, no matter on which server you 12 everything should look the same, no matter on which server you
13 are. This directory contains some subdirectories, which are 13 are. This directory contains some subdirectories, which are
14 explained below.</para> 14 explained below.</para>
@@ -96,28 +96,49 @@ @@ -96,28 +96,49 @@
96 linkend="ftp-packages"/>.</para> 96 linkend="ftp-packages"/>.</para>
97 97
98</sect1> 98</sect1>
99<sect1 id="ftp-source"> 99<sect1 id="ftp-source">
100<title><filename>current</filename>, 100<title><filename>current</filename>,
101<filename>stable</filename>, 101<filename>stable</filename>,
102<filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>: 102<filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>:
103source packages</title> 103source packages</title>
104 104
105 <para>These directories contain the <quote>real</quote> pkgsrc, 105 <para>These directories contain the <quote>real</quote> pkgsrc,
106 that is the files that define how to create binary packages from 106 that is the files that define how to create binary packages from
107 source archives.</para> 107 source archives.</para>
108 108
 109 <para>Each of the <filename>current</filename>,
 110 <filename>stable</filename> and
 111 <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>
 112 directories share the same structure. They each contain a
 113 <filename>pkgsrc</filename> directory and
 114 <filename>pkgsrc.tar.{bz,gz,xz}</filename> file.</para>
 115
109 <para>The directory <filename>pkgsrc</filename> contains a 116 <para>The directory <filename>pkgsrc</filename> contains a
110 snapshot of the CVS repository, which is updated regularly. The 117 snapshot of the CVS repository, which is updated regularly. The
111 file <filename>pkgsrc.tar.gz</filename> contains the same as the 118 file <filename>pkgsrc.tar.{bz,gz,xz}</filename> contains the same
112 directory, ready to be downloaded as a whole.</para> 119 as the directory, ready to be downloaded as a whole.</para>
113 120
114 <para>In the directories for the quarterly branches, there is an 121 <para>The <filename>current</filename> directory contains files
115 additional file called 122 related to the HEAD branch of the CVS repository.
116 <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable>.tar.gz</filename>, 123 In this directory there is an additional file called
 124 <filename>pkgsrc-readmes.tar.{bz,gz,xz}</filename> that contains
 125 all pkgsrc <filename>README</filename>s with information about
 126 categories and packages.
 127 </para>
 128
 129 <para>The <filename>stable</filename> directory is a symlink to
 130 the latest
 131 <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>.
 132 </para>
 133
 134 <para>The
 135 <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>.
 136 directories contain files related to the
 137 <filename>-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>
 138 stable branch of the CVS repository. In these directories there is
 139 an additional file called
 140 <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable>.tar.{bz,gz,xz}</filename>,
117 which contains the state of pkgsrc when it was branched.</para> 141 which contains the state of pkgsrc when it was branched.</para>
118 142
119 <para><filename>stable</filename> directory points to the latest 
120 quarterly branch.</para> 
121 
122</sect1> 143</sect1>
123</appendix> 144</appendix>