[pkgsrc/trunk]: pkgsrc/doc/guide/files Documented the new filesystem layout o...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/bf3fe6c81675
branches:  trunk
changeset: 531224:bf3fe6c81675
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Wed Jul 25 17:53:44 2007 +0000

description:
Documented the new filesystem layout on ftp.NetBSD.org.

diffstat:

 doc/guide/files/ftp-layout.xml |  40 +++++++++++++++++++++++++---------------
 1 files changed, 25 insertions(+), 15 deletions(-)

diffs (57 lines):

diff -r 9b5f0ca82007 -r bf3fe6c81675 doc/guide/files/ftp-layout.xml
--- a/doc/guide/files/ftp-layout.xml    Wed Jul 25 17:26:59 2007 +0000
+++ b/doc/guide/files/ftp-layout.xml    Wed Jul 25 17:53:44 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: ftp-layout.xml,v 1.7 2006/11/23 11:42:54 yyamano Exp $ -->
+<!-- $NetBSD: ftp-layout.xml,v 1.8 2007/07/25 17:53:44 rillig Exp $ -->
 
 <appendix id="ftp-layout">
 <title>Directory layout of the pkgsrc FTP server</title>
@@ -46,23 +46,33 @@
 
 </sect1>
 <sect1 id="ftp-packages">
-<title><filename>packages*</filename>: Binary packages</title>
+<title><filename>packages</filename>: Binary packages</title>
+
+       <para>This directory contains binary packages for the various
+       platforms that are supported by pkgsrc.
+       Each subdirectory is of the form <replaceable>OPSYS</replaceable
+       >/<replaceable>ARCH</replaceable
+       >/<replaceable>OSVERSION_TAG</replaceable
+       >. The meaning of these variables is:</para>
 
-       <para>These directories contain binary packages. Those
-       directories that have a branch name
-       (200<replaceable>x</replaceable>Q<replaceable>y</replaceable>)
-       contain packages from that particular branch. The directory
-       <filename>packages</filename> contains binary packages from
-       pkgsrc-current. (However, this does not necessarily mean that
-       the packages are still current anymore.)</para>
+       <itemizedlist>
+       <listitem><para><varname>OPSYS</varname> is the name of the operating system for which the packages have been built,</para></listitem>
+       <listitem><para><varname>ARCH</varname> is the hardware architecture,</para></listitem>
+       <listitem><para><varname>OSVERSION</varname> is the version of the operating system,</para></listitem>
+       <listitem><para><varname>TAG</varname> is either <literal>200<replaceable>x</replaceable>Q<replaceable>y</replaceable></literal> for a stable branch, or <literal>head</literal> for packages 
built from the HEAD branch.</para></listitem>
+       </itemizedlist>
 
-       <para>Below the <filename>packages*</filename> directories are
-       directories that distinguish the packages by operating system
-       and version, the next directory level specifies the hardware
-       architecture.</para>
+       <para>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
+       can quickly click through the directories on the
+       server and find the best binary packages for their machines. Since they
+       usually know the operating system and the hardware architecture, OPSYS
+       and ARCH are placed first. After these choices, they can select the
+       best combination of OSVERSION and TAG together, since it is usually the
+       case that packages stay compatible between different version of the
+       operating system.</para>
 
-       <para>In each of the platform-specific directories, there is a
-       whole binary packages collection. It has a directory called
+       <para>In each of these directories, there is a
+       whole binary packages collection for a specific platform. It has a directory called
        <filename>All</filename> which contains all binary packages.
        Besides that, there are various category directories that
        contain symbolic links to the real binary packages.</para>