Updated docs

Author: jgg
Date: 1998-12-14 04:00:33 GMT
Updated docs

3 files changed, 52 insertions, 17 deletions

diff --git a/doc/examples/apt.conf b/doc/examples/apt.conf
index 061b082dd..57292b8fc 100644
--- a/doc/examples/apt.conf
+++ b/doc/examples/apt.conf
@@ -1,4 +1,4 @@
-// $Id: apt.conf,v 1.18 1998/12/06 22:51:14 jgg Exp $
+// $Id: apt.conf,v 1.19 1998/12/14 04:00:34 jgg Exp $
 /* This file is an index of all APT configuration directives. It should
    NOT actually be used as a real config file, though it is a completely
    valid file.
@@ -78,7 +78,8 @@ Dir
      lists "lists/";
      xstatus "xstatus";
      userstatus "status.user";
-     status "/var/lib/dpkg/status";     
+     status "/var/lib/dpkg/status";
+     cdroms "cdroms.list";
   };
   
   // Location of the cache dir
diff --git a/doc/files.sgml b/doc/files.sgml
index 2d4b1eac0..e86b2def1 100644
--- a/doc/files.sgml
+++ b/doc/files.sgml
@@ -4,7 +4,7 @@
 <title>APT Files</title>
 
 <author>Jason Gunthorpe <email>jgg@debian.org</email></author>
-<version>$Id: files.sgml,v 1.3 1998/10/02 04:39:57 jgg Exp $</version>
+<version>$Id: files.sgml,v 1.4 1998/12/14 04:00:33 jgg Exp $</version>
 
 <abstract>
 This document describes the complete implementation and format of the 
@@ -45,6 +45,8 @@ The var directory structure is as follows:
 		  lists/
 		       partial/
 		  xstatus
+		  userstatus
+		  cdroms.list
   /var/cache/apt/
                   pkgcache.bin
 		  srcpkgcache.bin
@@ -52,12 +54,15 @@ The var directory structure is as follows:
 		          partial/
   /etc/apt/
            sources.list
-	   cdromdevs.list
+	   apt.conf
   /usr/lib/apt/
                 methods/
 		       cdrom
 		       ftp
 		       http
+		       file
+		       gzip
+		       copy
 </example>
 
 <p>
@@ -80,7 +85,7 @@ support a mix of source media. The file lists one source per line, with the
 fastest source listed first. The format of each line is:
 
 <p>
-<var>type ui args</var>
+<var>type uri args</var>
 
 <p>
 The first item, <var>type</var>, indicates the format for the remainder 
@@ -122,17 +127,14 @@ URIs in the source list support a large number of access schemes.
 <tag>cdrom<item>
    The cdrom scheme is special in that If Modifed Since queries are never
    performed and that APT knows how to match a cdrom to the name it
-   was given when first inserted. It does this by examining the date
-   and size of the package file. APT also knows all of the possible 
-   prefix paths for the cdrom drives and that the user should be prompted
+   was given when first inserted. APT also knows all of the possible 
+   mount points the cdrom drives and that the user should be prompted
    to insert a CD if it cannot be found. The path is relative to an 
    arbitary mount point (of APT's choosing) and must not start with a 
    slash. The first pathname component is the given name and is purely
    descriptive and of the users choice. However, if a file in the root of 
-   the cdrom is called 'cdname' its contents will be used instead of 
+   the cdrom is called '.disk/info' its contents will be used instead of 
    prompting. The name serves as a tag for the cdrom and should be unique.
-   APT will track the CDROM's based on their tag and package file
-   properties.
    <example>
    cdrom:Debian 1.3/debian
    </example>
@@ -140,8 +142,7 @@ URIs in the source list support a large number of access schemes.
 <tag>http<item>
    This scheme specifies a HTTP server for the debian archive. HTTP is prefered
    over FTP because If Modified Since queries against the Package file are
-   possible. Newer HTTP protcols may even support reget which would make
-   http the protocol of choice.
+   possible as well as deep pipelining and resume capabilities.
    <example>
    http://www.debian.org/archive
    </example>
diff --git a/doc/method.sgml b/doc/method.sgml
index d1ebddcf5..ae4b713f1 100644
--- a/doc/method.sgml
+++ b/doc/method.sgml
@@ -4,7 +4,7 @@
 <title>APT Method Interface </title>
 
 <author>Jason Gunthorpe <email>jgg@debian.org</email></author>
-<version>$Id: method.sgml,v 1.5 1998/12/04 21:16:54 jgg Exp $</version>
+<version>$Id: method.sgml,v 1.6 1998/12/14 04:00:34 jgg Exp $</version>
 
 <abstract>
 This document describes the interface that APT uses to the archive
@@ -33,7 +33,7 @@ For more details, on Debian GNU/Linux systems, see the file
 
 <p>
 The APT method interface allows APT to acquire archive files (.deb), index
-files (Packages, Revision, Mirrors) and source files (.tar.gz, .diff). It
+files (Packages, Release, Mirrors) and source files (.tar.gz, .diff). It
 is a general, extensible system designed to satisfy all of these
 requirements:
 
@@ -307,9 +307,42 @@ Fields: Media, Fail
 
 </sect>
                                                                   <!-- }}} -->
-<!-- Examples		                                               {{{ -->
+<!-- Method Notes		                                       {{{ -->
 <!-- ===================================================================== -->
-<sect>Examples
+<sect>Notes
+
+<p>
+The methods supplied by the stock apt are:
+<enumlist>
+<item>cdrom - For Multi-Disc CDROMs
+<item>copy - (internal) For copying files around the filesystem
+<item>file - For local files
+<item>gzip - (internal) For decompression
+<item>http - For HTTP servers
+</enumlist>
+
+<p>
+The two internal methods, copy and gzip, are used by the acquire code to
+parallize and simplify the automatic decompression of package files as well 
+as copying package files around the file system. Both methods can be seen to 
+act the same except that one decompresses on the fly. APT uses them by
+generating a copy URI that is formed identically to a file URI. The destination
+file is send as normal. The method then takes the file specified by the 
+URI and writes it to the destination file. A typical set of operations may
+be:
+<example>
+http://foo.com/Packages.gz -> /bar/Packages.gz
+gzip:/bar/Packages.gz -> /bar/Packages.decomp
+rename Packages.decomp to /final/Packages
+</example>
+
+<p>
+The http method implements a fully featured HTTP/1.1 client that supports
+deep pipelining and reget. It works best when coupled with an apache 1.3
+server. The file method simply generates failures or success responses with
+the filename field set to the proper location. The cdrom method acts the same
+except that it checks that the mount point has a valid cdrom in it. It does 
+this by (effectively) computing a md5 hash of 'ls -l' on the mountpoint.
 
 </sect>
                                                                   <!-- }}} -->