diff options
author | leot <leot@pkgsrc.org> | 2019-02-28 10:54:31 +0000 |
---|---|---|
committer | leot <leot@pkgsrc.org> | 2019-02-28 10:54:31 +0000 |
commit | 15c1c60c1face112dc1091bf5f4071a149337680 (patch) | |
tree | 2cb6e51010d0af6f79c29ee5557ccce008e7aaef /doc/guide | |
parent | d1687215e91aeb06560fd21df13b678f546d6735 (diff) | |
download | pkgsrc-15c1c60c1face112dc1091bf5f4071a149337680.tar.gz |
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}'
Diffstat (limited to 'doc/guide')
-rw-r--r-- | doc/guide/files/ftp-layout.xml | 41 |
1 files changed, 31 insertions, 10 deletions
diff --git a/doc/guide/files/ftp-layout.xml b/doc/guide/files/ftp-layout.xml index a59510a2b59..016fcddeb83 100644 --- a/doc/guide/files/ftp-layout.xml +++ b/doc/guide/files/ftp-layout.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: ftp-layout.xml,v 1.14 2019/02/26 12:11:49 leot Exp $ --> +<!-- $NetBSD: ftp-layout.xml,v 1.15 2019/02/28 10:54:31 leot Exp $ --> <appendix id="ftp-layout"> <title>Directory layout of the pkgsrc FTP server</title> @@ -106,18 +106,39 @@ source packages</title> that is the files that define how to create binary packages from source archives.</para> + <para>Each of the <filename>current</filename>, + <filename>stable</filename> and + <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename> + directories share the same structure. They each contain a + <filename>pkgsrc</filename> directory and + <filename>pkgsrc.tar.{bz,gz,xz}</filename> file.</para> + <para>The directory <filename>pkgsrc</filename> contains a snapshot of the CVS repository, which is updated regularly. The - file <filename>pkgsrc.tar.gz</filename> contains the same as the - directory, ready to be downloaded as a whole.</para> - - <para>In the directories for the quarterly branches, there is an - additional file called - <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable>.tar.gz</filename>, + file <filename>pkgsrc.tar.{bz,gz,xz}</filename> contains the same + as the directory, ready to be downloaded as a whole.</para> + + <para>The <filename>current</filename> directory contains files + related to the HEAD branch of the CVS repository. + In this directory there is an additional file called + <filename>pkgsrc-readmes.tar.{bz,gz,xz}</filename> that contains + all pkgsrc <filename>README</filename>s with information about + categories and packages. + </para> + + <para>The <filename>stable</filename> directory is a symlink to + the latest + <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>. + </para> + + <para>The + <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename>. + directories contain files related to the + <filename>-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable></filename> + stable branch of the CVS repository. In these directories there is + an additional file called + <filename>pkgsrc-20<replaceable>xx</replaceable>Q<replaceable>y</replaceable>.tar.{bz,gz,xz}</filename>, which contains the state of pkgsrc when it was branched.</para> - <para><filename>stable</filename> directory points to the latest - quarterly branch.</para> - </sect1> </appendix> |