From 1681d035e6c4adced1d8c34900bed7f86f86b0a4 Mon Sep 17 00:00:00 2001 From: Cameron Dale Date: Sat, 20 Mar 2010 23:41:55 -0700 Subject: [PATCH] Fix various documentation issues (Closes: #518590, #518549, #518548, 518550) --- apt-p2p.conf | 9 +++++++-- debian/apt-p2p.conf.sgml | 13 ++++++++----- debian/apt-p2p.sgml | 15 +++++++++++++-- debian/changelog | 4 +++- debian/control | 2 +- 5 files changed, 32 insertions(+), 11 deletions(-) diff --git a/apt-p2p.conf b/apt-p2p.conf index 6d4a00f..0620979 100644 --- a/apt-p2p.conf +++ b/apt-p2p.conf @@ -36,7 +36,10 @@ CACHE_DIR = /var/cache/apt-p2p # for everybody to download # OTHER_DIRS = -# Whether it's OK to use an IP address from a known local/private range +# Whether it's OK for the application to use for sharing files an IP +# address from a known local or private range (RFC 1918). This should +# only be set true if you are running your own private apt-p2p network +# that no one else will be connecting to. LOCAL_OK = no # Whether a remote peer can access the statistics page @@ -106,7 +109,9 @@ MIN_PING_INTERVAL = 15m BUCKET_STALENESS = 1h # Whether it's OK to add nodes to the routing table that use an IP -# address from a known local/private range. +# address from a known local or private range (RFC 1918). This should +# only be set true if you are running your own private apt-p2p network +# that no one else will be connecting to. # If not specified here, the LOCAL_OK value in the DEFAULT section will be used. # LOCAL_OK = no diff --git a/debian/apt-p2p.conf.sgml b/debian/apt-p2p.conf.sgml index 288864e..e8938d3 100644 --- a/debian/apt-p2p.conf.sgml +++ b/debian/apt-p2p.conf.sgml @@ -52,7 +52,7 @@ entries overriding former ones: /etc/apt-p2p/apt-p2p.conf - ${HOME}/.apt-p2p/apt-p2p.conf + $HOME/.apt-p2p/apt-p2p.conf the location specified by the config-file parameter @@ -115,7 +115,7 @@ The directory to store the downloaded files in. - (Default is ${HOME}/.apt-p2p/cache.) + (Default is $HOME/.apt-p2p/cache.) @@ -129,7 +129,9 @@ - Whether it's OK to use an IP address from a known local or private range. + Whether it's OK for the application to use for sharing files an IP address from a + known local or private range (RFC 1918). This should only be set true if you are running + your own private apt-p2p network that no one else will be connecting to. (Default is false) @@ -266,8 +268,9 @@ - Whether it's OK to add nodes to the routing table that use an IP address - from a known local or private range. + Whether it's OK to add nodes to the routing table that use an IP address from a + known local or private range (RFC 1918). This should only be set true if you are running + your own private apt-p2p network that no one else will be connecting to. (Default is to use the value specified in the DEFAULT section.) diff --git a/debian/apt-p2p.sgml b/debian/apt-p2p.sgml index d8e9597..d8baf39 100644 --- a/debian/apt-p2p.sgml +++ b/debian/apt-p2p.sgml @@ -47,7 +47,7 @@ Normally &dhpackage; is run from init.d using twistd, in which case no &dhpackage; options can be specified on the command-line, and all configuration variables are - read from the default config file locations of ${HOME}/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf. + read from the default config file locations of $HOME/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf. The command is then: twistd -y /path/to/&dhpackage; @@ -103,6 +103,17 @@ + + + PRIVATE NETWORKS + + Apt-P2P is not designed to function as a downloader for multiple + clients on a private network. Apt-P2P checks the source of incoming + requests and only responds to those from the localhost. For more + information: + + + @@ -118,7 +129,7 @@ the filename to use for the configuration file, options found in this - file are combined with those in ${HOME}/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf + file are combined with those in $HOME/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf (see apt-p2p.conf5 for the format of the file) diff --git a/debian/changelog b/debian/changelog index 98b7ea9..688617b 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,8 +2,10 @@ apt-p2p (0.1.6) unstable; urgency=low * Fix a lot of lintian warnings and errors - Update standards version to 3.8.4 (no changes) + * Fix various documentation issues + (Closes: #518590, #518549, #518548, 518550) - -- Cameron Dale Sat, 20 Mar 2010 22:48:07 -0700 + -- Cameron Dale Sat, 20 Mar 2010 23:26:24 -0700 apt-p2p (0.1.5) unstable; urgency=low diff --git a/debian/control b/debian/control index 1b70b7a..3e1b1de 100644 --- a/debian/control +++ b/debian/control @@ -2,7 +2,7 @@ Source: apt-p2p Section: net Priority: optional Maintainer: Cameron Dale -Homepage: http://www.camrdale.org/apt-p2p.html +Homepage: http://www.camrdale.org/apt-p2p/ Standards-Version: 3.8.4 Build-Depends: debhelper (>= 5.0.37.2) Build-Depends-Indep: python, python-support (>= 0.5.4), docbook-to-man -- 2.39.5