Bug#110389: Please add doc-base support [patch]
Package: apt
Version: 0.5.4
Severity: wishlist
Tags: patch
Hi,
Currently apt supports only dhelp documentation system.
I wrote a patch which adds doc-base support to apt, so apt docs can
be viewed with not only dhelp, but also with tools like dwww or
doc-central. Also the patch fixes some '/usr/doc' references in
documentation and a typo.
After applying the patch, you can remove unnecessary debian/*dhelp,
debian/libapt-pkg-doc.postinst and debian/libapt-pkg-doc.prerm files.
It would be very nice if you consider including the patch in the
release of apt.
Regards,
Robert
--
Robert Luberda * robert@pingu.ii.uj.edu.pl * robert@debian.org
* GnuPG: AEE0 1F85 3E63 8BAA CDF1 3D18 4E18 7570 9D30 9C3B *
diff -Nur apt-0.5.4/debian/apt.doc-base.apt-offline-guide apt-0.5.4.1/debian/apt.doc-base.apt-offline-guide
--- apt-0.5.4/debian/apt.doc-base.apt-offline-guide Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/apt.doc-base.apt-offline-guide Mon Aug 27 20:21:20 2001
@@ -0,0 +1,13 @@
+Document: apt-offline-guide
+Title: APT Offline Usage Guide
+Author: Jason Gunthorpe
+Abstract: The APT Offline Usage Guide provides detailed instructions
+ and examples of how to use APT on an unconnected computer.
+Section: Debian
+
+Format: text
+Files: /usr/share/doc/apt/offline.text.gz
+
+Format: HTML
+Index: /usr/share/doc/apt/offline.html/index.html
+Files: /usr/share/doc/apt/offline.html/*.html
diff -Nur apt-0.5.4/debian/apt.doc-base.apt-users-guide apt-0.5.4.1/debian/apt.doc-base.apt-users-guide
--- apt-0.5.4/debian/apt.doc-base.apt-users-guide Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/apt.doc-base.apt-users-guide Mon Aug 27 20:21:26 2001
@@ -0,0 +1,13 @@
+Document: apt-users-guide
+Title: APT User's Guide
+Author: Jason Gunthorpe
+Abstract: The APT User's Guide provides an overview of how to use the APT
+ package manager, and provides a detailed look at the apt-get tool.
+Section: Debian
+
+Format: text
+Files: /usr/share/doc/apt/guide.text.gz
+
+Format: HTML
+Index: /usr/share/doc/apt/guide.html/index.html
+Files: /usr/share/doc/apt/guide.html/*.html
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-cache apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-cache
--- apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-cache Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-cache Mon Aug 27 20:21:31 2001
@@ -0,0 +1,18 @@
+Document: apt-cache
+Title: APT Cache Specification
+Author: Jason Gunthorpe
+Abstract: The APT Cache Specification describes the complete implementation
+ and format of the APT Cache file. The APT Cache file is a way for APT to parse
+ and store a large number of package files for display in the UI. It's primary
+ design goal is to make display of a single package in the tree very
+ fast by pre-linking important things like dependencies and provides.
+ The specification doubles as documentation for one of the in-memory
+ structures used by the package library and the APT GUI.
+Section: Apps/Devel
+
+Format: text
+Files: /usr/share/doc/libapt-pkg-doc/cache.text.gz
+
+Format: HTML
+Index: /usr/share/doc/libapt-pkg-doc/cache.html/index.html
+Files: /usr/share/doc/libapt-pkg-doc/cache.html/*.html
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-design apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-design
--- apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-design Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-design Mon Aug 27 20:21:35 2001
@@ -0,0 +1,14 @@
+Document: apt-design
+Title: APT Design Document
+Author: Jason Gunthorpe
+Abstract: The APT Design Document is an overview of the specifications and
+ design goals of the APT project. It also attempts to give a broad
+ descriptiontion of the implementation as well.
+Section: Apps/Devel
+
+Format: text
+Files: /usr/share/doc/libapt-pkg-doc/design.text.gz
+
+Format: HTML
+Index: /usr/share/doc/libapt-pkg-doc/design.html/index.html
+Files: /usr/share/doc/libapt-pkg-doc/design.html/*.html
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-dpkg-manual apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-dpkg-manual
--- apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-dpkg-manual Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-dpkg-manual Mon Aug 27 20:21:39 2001
@@ -0,0 +1,13 @@
+Document: apt-dpkg-manual
+Title: DPkg Technical Manual
+Author: Jason Gunthorpe
+Abstract: The DPkg Technical Manual gives an overview of dpkg's external
+ functions and describes how it views the world.
+Section: Apps/Devel
+
+Format: text
+Files: /usr/share/doc/libapt-pkg-doc/dpkg-tech.text.gz
+
+Format: HTML
+Index: /usr/share/doc/libapt-pkg-doc/dpkg-tech.html/index.html
+Files: /usr/share/doc/libapt-pkg-doc/dpkg-tech.html/*.html
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-files apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-files
--- apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-files Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-files Mon Aug 27 20:21:46 2001
@@ -0,0 +1,14 @@
+Document: apt-files
+Title: APT Files
+Author: Jason Gunthorpe
+Abstract: The APT Files document describes the complete implementation and
+ format of the installed APT directory structure. It also serves as guide
+ to how APT views the Debian archive.
+Section: Apps/Devel
+
+Format: text
+Files: /usr/share/doc/libapt-pkg-doc/files.text.gz
+
+Format: HTML
+Index: /usr/share/doc/libapt-pkg-doc/files.html/index.html
+Files: /usr/share/doc/libapt-pkg-doc/files.html/*.html
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-interface apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-interface
--- apt-0.5.4/debian/libapt-pkg-doc.doc-base.apt-interface Thu Jan 1 01:00:00 1970
+++ apt-0.5.4.1/debian/libapt-pkg-doc.doc-base.apt-interface Mon Aug 27 20:21:50 2001
@@ -0,0 +1,13 @@
+Document: apt-interface
+Title: APT Method Interface
+Author: Jason Gunthorpe
+Abstract: The APT Method Interface document describes the interface that APT
+ uses to the archive access methods.
+Section: Apps/Devel
+
+Format: text
+Files: /usr/share/doc/libapt-pkg-doc/method.text.gz
+
+Format: HTML
+Index: /usr/share/doc/libapt-pkg-doc/method.html/index.html
+Files: /usr/share/doc/libapt-pkg-doc/method.html/*.html
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.postinst apt-0.5.4.1/debian/libapt-pkg-doc.postinst
--- apt-0.5.4/debian/libapt-pkg-doc.postinst Tue Dec 7 08:38:19 1999
+++ apt-0.5.4.1/debian/libapt-pkg-doc.postinst Mon Aug 27 19:26:22 2001
@@ -1,11 +1,3 @@
#! /bin/sh
-case "$1" in
- configure)
- if [ -f /usr/sbin/dhelp_parse ]; then
- /usr/sbin/dhelp_parse -a /usr/doc/libapt-pkg-doc
- fi
- ;;
-esac
-
#DEBHELPER#
diff -Nur apt-0.5.4/debian/libapt-pkg-doc.prerm apt-0.5.4.1/debian/libapt-pkg-doc.prerm
--- apt-0.5.4/debian/libapt-pkg-doc.prerm Tue Dec 21 08:25:35 1999
+++ apt-0.5.4.1/debian/libapt-pkg-doc.prerm Mon Aug 27 19:26:37 2001
@@ -1,13 +1,3 @@
#! /bin/sh
-case "$1" in
- remove|upgrade|remove-in-favour|deconfigure-in-favour)
- if [ -f /usr/sbin/dhelp_parse ]; then
- /usr/sbin/dhelp_parse -d /usr/doc/libapt-pkg-doc
- fi
- ;;
- failed-upgrade)
- ;;
-esac
-
#DEBHELPER#
diff -Nur apt-0.5.4/debian/postinst apt-0.5.4.1/debian/postinst
--- apt-0.5.4/debian/postinst Mon Feb 7 02:45:31 2000
+++ apt-0.5.4.1/debian/postinst Mon Aug 27 19:27:11 2001
@@ -14,7 +14,7 @@
{
echo "/etc/apt/sources.list does not exist; creating a default setup."
- cp /usr/doc/apt/examples/sources.list /etc/apt/sources.list
+ cp /usr/share/doc/apt/examples/sources.list /etc/apt/sources.list
}
check_apt_conf ()
@@ -38,8 +38,5 @@
echo "packages, please edit the file /etc/apt/sources.list."
else
check_apt_conf
- fi
- if [ -f /usr/sbin/dhelp_parse ]; then
- /usr/sbin/dhelp_parse -a /usr/doc/apt
fi
esac
diff -Nur apt-0.5.4/debian/rules apt-0.5.4.1/debian/rules
--- apt-0.5.4/debian/rules Fri Aug 3 06:58:10 2001
+++ apt-0.5.4.1/debian/rules Mon Aug 27 20:22:36 2001
@@ -124,8 +124,6 @@
$(BLD)/docs/files* $(BLD)/docs/method* \
doc/libapt-pkg2_to_3.txt doc/style.txt
- -cp -a debian/libapt-pkg-doc.dhelp debian/libapt-pkg-doc/usr/doc/libapt-pkg-doc/.dhelp
- -cp -a debian/libapt-pkg-doc.dhelp debian/libapt-pkg-doc/usr/share/doc/libapt-pkg-doc/.dhelp
dh_installexamples -p$@
# dh_installmenu -p$@
@@ -173,9 +171,6 @@
dh_installdocs -p$@ $(BLD)/docs/guide*.text $(BLD)/docs/guide*.html \
$(BLD)/docs/offline.text $(BLD)/docs/offline.html
- # One or the other..
- -cp -a debian/dhelp debian/apt/usr/doc/apt/.dhelp
- -cp -a debian/dhelp debian/apt/usr/share/doc/apt/.dhelp
# head -n 500 ChangeLog > debian/ChangeLog
diff -Nur apt-0.5.4/doc/cache.sgml apt-0.5.4.1/doc/cache.sgml
--- apt-0.5.4/doc/cache.sgml Wed Apr 4 07:00:14 2001
+++ apt-0.5.4.1/doc/cache.sgml Mon Aug 27 19:31:36 2001
@@ -28,7 +28,7 @@
<p>
For more details, on Debian GNU/Linux systems, see the file
-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.
</copyright>
<toc sect>
diff -Nur apt-0.5.4/doc/design.sgml apt-0.5.4.1/doc/design.sgml
--- apt-0.5.4/doc/design.sgml Wed Apr 4 07:00:15 2001
+++ apt-0.5.4.1/doc/design.sgml Mon Aug 27 19:28:29 2001
@@ -32,7 +32,7 @@
<p>
You should have received a copy of the GNU General Public
License with your Debian GNU/Linux system, in
- <tt>/usr/doc/copyright/GPL</tt>, or with the
+ <tt>/usr/share/common-licenses/GPL</tt>, or with the
<prgn/debiandoc-sgml/ source package as the file
<tt>COPYING</tt>. If not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
diff -Nur apt-0.5.4/doc/dpkg-tech.sgml apt-0.5.4.1/doc/dpkg-tech.sgml
--- apt-0.5.4/doc/dpkg-tech.sgml Thu Jul 2 04:58:12 1998
+++ apt-0.5.4.1/doc/dpkg-tech.sgml Mon Aug 27 19:28:38 2001
@@ -22,7 +22,7 @@
<p>
For more details, on Debian GNU/Linux systems, see the file
-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.
</copyright>
<toc sect>
diff -Nur apt-0.5.4/doc/files.sgml apt-0.5.4.1/doc/files.sgml
--- apt-0.5.4/doc/files.sgml Wed Apr 4 07:00:15 2001
+++ apt-0.5.4.1/doc/files.sgml Mon Aug 27 19:28:46 2001
@@ -22,7 +22,7 @@
<p>
For more details, on Debian GNU/Linux systems, see the file
-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.
</copyright>
<toc sect>
diff -Nur apt-0.5.4/doc/guide.it.sgml apt-0.5.4.1/doc/guide.it.sgml
--- apt-0.5.4/doc/guide.it.sgml Tue Feb 20 08:03:17 2001
+++ apt-0.5.4.1/doc/guide.it.sgml Mon Aug 27 19:28:52 2001
@@ -31,7 +31,7 @@
<p>
Per ulteriori dettagli sui sistemi GNU/Linux si veda il testo
completo della licenza nel file
-/usr/doc/copyright/GPL.
+/usr/share/common-licenses/GPL.
</copyright>
<toc sect>
diff -Nur apt-0.5.4/doc/guide.sgml apt-0.5.4.1/doc/guide.sgml
--- apt-0.5.4/doc/guide.sgml Tue Apr 10 09:02:55 2001
+++ apt-0.5.4.1/doc/guide.sgml Mon Aug 27 19:28:58 2001
@@ -20,7 +20,7 @@
<p>
For more details, on Debian GNU/Linux systems, see the file
-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.
</copyright>
<toc sect>
diff -Nur apt-0.5.4/doc/method.sgml apt-0.5.4.1/doc/method.sgml
--- apt-0.5.4/doc/method.sgml Wed Apr 4 07:00:15 2001
+++ apt-0.5.4.1/doc/method.sgml Mon Aug 27 19:29:21 2001
@@ -21,7 +21,7 @@
<p>
For more details, on Debian GNU/Linux systems, see the file
-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.
</copyright>
<toc sect>
diff -Nur apt-0.5.4/doc/offline.sgml apt-0.5.4.1/doc/offline.sgml
--- apt-0.5.4/doc/offline.sgml Tue Aug 7 06:58:38 2001
+++ apt-0.5.4.1/doc/offline.sgml Mon Aug 27 19:31:06 2001
@@ -21,7 +21,7 @@
<p>
For more details, on Debian GNU/Linux systems, see the file
-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.
</copyright>
<toc sect>
@@ -122,7 +122,7 @@
</example>
More details can be seen by examining the apt.conf man page and the sample
-configuration file in <em>/usr/doc/apt/examples/apt.conf</em>.
+configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>.
<p>
On the remote Debian machine the first thing to do is mount the disc and copy
@@ -140,7 +140,7 @@
</example>
The dist-upgrade command can be replaced with any-other standard APT commands,
-particularly dselect-upgrad. You can even use an APT front end such as
+particularly dselect-upgrade. You can even use an APT front end such as
<em>dselect</em> However this presents a problem in communicating your
selections back to the local computer.
diff -Nur apt-0.5.4/dselect/desc.apt apt-0.5.4.1/dselect/desc.apt
--- apt-0.5.4/dselect/desc.apt Sat Aug 21 06:53:53 1999
+++ apt-0.5.4.1/dselect/desc.apt Mon Aug 27 19:32:03 2001
@@ -6,4 +6,4 @@
HTTP proxies can be used by setting http_proxy="http://proxy:port/"; before
running DSelect. FTP proxies require special configuration detailed in
-the apt.conf(5) man page (see /usr/doc/apt/examples/apt.conf)
+the apt.conf(5) man page (see /usr/share/doc/apt/examples/apt.conf)
Reply to: