]> git.michaelhowe.org Git - packages/o/openafs.git/commitdiff
* Subsume openafs-doc into this source package.
authorRuss Allbery <rra@debian.org>
Wed, 29 Mar 2006 00:11:58 +0000 (00:11 +0000)
committerRuss Allbery <rra@debian.org>
Wed, 29 Mar 2006 00:11:58 +0000 (00:11 +0000)
debian/changelog
debian/control
debian/copyright
debian/openafs-doc.README.Debian [new file with mode: 0644]
debian/openafs-doc.doc-base.openafs-admin [new file with mode: 0644]
debian/openafs-doc.doc-base.openafs-admin-ref [new file with mode: 0644]
debian/openafs-doc.doc-base.openafs-quick [new file with mode: 0644]
debian/openafs-doc.doc-base.openafs-user [new file with mode: 0644]
debian/openafs-doc.docs [new file with mode: 0644]
debian/openafs-doc.examples [new file with mode: 0644]
debian/rules

index 32855bd75dac45367b306e7aa5d9cb92fe85b3c4..a746e0751c708fbbc6a7053c73105a2222f72dbf 100644 (file)
@@ -4,10 +4,11 @@ openafs (1.4.0+rc10-1) UNRELEASED; urgency=low
     - Supports Linux 2.6.16.  (Closes: #358203)
     - Suspend should work with newer kernels.  (Closes: #341588)
     - Upstream now includes man pages, so remove our backport.
+  * Subsume openafs-doc into this source package.
   * Always pass the system type into Autoconf, following autotools-dev
     best practices.
 
- -- Russ Allbery <rra@debian.org>  Tue, 28 Mar 2006 14:09:37 -0800
+ -- Russ Allbery <rra@debian.org>  Tue, 28 Mar 2006 15:16:01 -0800
 
 openafs (1.4.0-4) unstable; urgency=low
 
index 7efa84366cb8dcfa682aeace3bfbdd7260a57252..0b4734b515925942c12411aec7638135d234e105 100644 (file)
@@ -64,6 +64,17 @@ Description: AFS distributed filesystem database server
  installed on the servers that will act as volume location and
  protection servers.
 
+Package: openafs-doc
+Section: doc
+Architecture: all
+Description: AFS distributed filesystem documentation
+ AFS is a distributed filesystem allowing cross-platform sharing of files
+ among multiple computers.  Facilities are provided for access control,
+ authentication, backup and administrative management.
+ .
+ This package contains the OpenAFS user's and reference manuals, some
+ protocol documentation, and other OpenAFS documentation.
+
 Package: libopenafs-dev
 Section: libdevel
 Architecture: i386 powerpc sparc alpha s390 ia64 hppa amd64 ppc64
index 0bed00b2f572993bc197d3b64f1e92d89898711c..bf4f6aab8dcd6456d081d21dee73e7f1ff1a921d 100644 (file)
@@ -16,6 +16,23 @@ the Apple Public Source License 2.0.  This license is not considered
 DFSG-free.  Since the repackaging was needed anyway, the WINNT directory
 was also dropped, reducing the size of the upstream tarball by 8MB.
 
+The openafs-doc contains the OpenAFS documentation as distributed by the
+OpenAFS project, which does not include the original source.  These
+documents were originally created using TeX internally by Transarc, the
+original authors of AFS.  By the time that AFS was released as free
+software by IBM after acquiring Transarc, the original source could no
+longer be found.  It has apparently been lost over the years.
+
+Although these HTML and PDF files would not normally be considered source,
+they're all that's available until they can be rewritten and updated in
+some better format.  They have been released under the IBM Public License
+Version 1.0 (included below), the same license as the rest of OpenAFS.
+
+Normally, this documentation could not be included in Debian without being
+accompanied by the original TeX source and build tools under DFSG#2, but
+under the circumstances, these files essentially are the source, as
+they're all that anyone has.
+
 Copyright:
 
    IBM Public License Version 1.0
diff --git a/debian/openafs-doc.README.Debian b/debian/openafs-doc.README.Debian
new file mode 100644 (file)
index 0000000..830381a
--- /dev/null
@@ -0,0 +1,23 @@
+OpenAFS Documentation for Debian
+--------------------------------
+
+Included in this package are the original Transarc AFS manuals with small
+modifications.  This is the best available comprehensive documentation for
+OpenAFS, but please be aware that this documentation has not been updated
+to reflect the changes made to OpenAFS since the original public release.
+Work on this is ongoing upstream, and newer documentation will be packaged
+as soon as it is available.
+
+All of the manuals are included because, even including significant
+portions that are not relevant to Debian, because they all do contain some
+valuable information.  Debian users should ignore the installation
+information and much of the Quick Start Guide in favor of the
+documentation that comes with the Debian OpenAFS packages, and should be
+aware that the IBM AFS 3.6 Release Notes are for the IBM release
+immediately prior to OpenAFS 1.0 (and are therefore rather dated).
+
+The AFS protocol information included here is dated and may not be
+accurate in all details, but is the best protocol information currently
+available.
+
+ -- Russ Allbery <rra@debian.org>, Sat Nov 19 12:45:55 2005
diff --git a/debian/openafs-doc.doc-base.openafs-admin b/debian/openafs-doc.doc-base.openafs-admin
new file mode 100644 (file)
index 0000000..92ae212
--- /dev/null
@@ -0,0 +1,11 @@
+Document: openafs-admin
+Title: AFS Administrator's Guide
+Author: IBM
+Abstract: Describes concepts and procedures for an AFS cell administrator.
+ This is a somewhat outdated guide to configuring and administering an AFS
+ cell and an introduction to AFS for those considering running it.
+Section: Apps/Net
+
+Format: HTML
+Index: /usr/share/doc/openafs-doc/html/AdminGuide/auagd000.htm
+Files: /usr/share/doc/openafs-doc/html/AdminGuide/*
diff --git a/debian/openafs-doc.doc-base.openafs-admin-ref b/debian/openafs-doc.doc-base.openafs-admin-ref
new file mode 100644 (file)
index 0000000..82047df
--- /dev/null
@@ -0,0 +1,13 @@
+Document: openafs-admin-ref
+Title: AFS Administration Reference
+Author: IBM
+Abstract: Detailed documentation of AFS commands and configuration files.
+ Included is documentation of user commands (fs, pts, etc.), the client
+ cache manager and debugging tools, and server processes (ptserver,
+ vlserver, fileserver, etc.).  This documentation is roughly equivalent
+ to man pages.
+Section: Apps/Net
+
+Format: HTML
+Index: /usr/share/doc/openafs-doc/html/AdminReference/auarf000.htm
+Files: /usr/share/doc/openafs-doc/html/AdminReference/*
diff --git a/debian/openafs-doc.doc-base.openafs-quick b/debian/openafs-doc.doc-base.openafs-quick
new file mode 100644 (file)
index 0000000..1973f16
--- /dev/null
@@ -0,0 +1,11 @@
+Document: openafs-quick
+Title: AFS Quick Start Guide for UNIX
+Author: IBM
+Abstract: Initial setup and configuration documentation for AFS on Unix
+ platforms.  Debian users can ignore most of the installation information,
+ but the configuration information is still useful.
+Section: Apps/Net
+
+Format: HTML
+Index: /usr/share/doc/openafs-doc/html/QuickStartUnix/auqbg000.htm
+Files: /usr/share/doc/openafs-doc/html/QuickStartUnix/*
diff --git a/debian/openafs-doc.doc-base.openafs-user b/debian/openafs-doc.doc-base.openafs-user
new file mode 100644 (file)
index 0000000..2108ed8
--- /dev/null
@@ -0,0 +1,10 @@
+Document: openafs-user
+Title: AFS User's Guide
+Author: IBM
+Abstract: Introduction and documentation of AFS for the end-user.  This is
+ the best document for people who will be using but not administering AFS.
+Section: Apps/Net
+
+Format: HTML
+Index: /usr/share/doc/openafs-doc/html/UserGuide/auusg000.htm
+Files: /usr/share/doc/openafs-doc/html/UserGuide/*
diff --git a/debian/openafs-doc.docs b/debian/openafs-doc.docs
new file mode 100644 (file)
index 0000000..a02509e
--- /dev/null
@@ -0,0 +1,3 @@
+doc/html
+doc/pdf
+doc/txt
diff --git a/debian/openafs-doc.examples b/debian/openafs-doc.examples
new file mode 100644 (file)
index 0000000..646ecf6
--- /dev/null
@@ -0,0 +1 @@
+doc/examples/CellAlias
index 92c13be028e3bcf10bf94f1e0cc0ce1947da8a63..2691de3a1bedb11ceea0847fd701646a5004043e 100755 (executable)
@@ -161,7 +161,8 @@ binary-indep: build install binary-source
        dh_testdir
        dh_testroot
        dh_installchangelogs NEWS
-       dh_installdocs
+       dh_installdocs -XQuickStartWindows -Xwinnotes
+       dh_installexamples
        dh_link
        dh_compress
        dh_fixperms