r293 - in /website/trunk: BugReporting.mdwn FAQ.mdwn Install.mdwn apt-transport-debtorrent.mdwn index.mdwn
camrdale-guest at users.alioth.debian.org
camrdale-guest at users.alioth.debian.org
Mon Sep 3 00:25:39 UTC 2007
Author: camrdale-guest
Date: Mon Sep 3 00:25:39 2007
New Revision: 293
URL: http://svn.debian.org/wsvn/debtorrent/?sc=1&rev=293
Log:
Update for debtorrent in the debian archive, add bug reporting and apt-transport-debtorrent pages.
Added:
website/trunk/BugReporting.mdwn
website/trunk/apt-transport-debtorrent.mdwn
Modified:
website/trunk/FAQ.mdwn
website/trunk/Install.mdwn
website/trunk/index.mdwn
Added: website/trunk/BugReporting.mdwn
URL: http://svn.debian.org/wsvn/debtorrent/website/trunk/BugReporting.mdwn?rev=293&op=file
==============================================================================
--- website/trunk/BugReporting.mdwn (added)
+++ website/trunk/BugReporting.mdwn Mon Sep 3 00:25:39 2007
@@ -1,0 +1,79 @@
+Since this is a new project, it is bound to have bugs, which can only
+be fixed if they are reported to the developers. So, please, if you do
+find a bug, report it, even if you can't or won't follow the guildelines
+below. If you do follow the guidelines below, that will help the
+developers to both understand your bug, and fix it promptly.
+
+## Reporting
+
+Before you report a bug, please check the [existing bugs for
+debtorrent][10] and [apt-transport-debtorrent][20] to be sure the bug
+has not been reported before. You may also want to check the [[FAQ]] to
+be sure you are using the program correctly.
+
+[10]: http://bugs.debian.org/src:debtorrent
+[20]: https://alioth.debian.org/tracker/?atid=412875&group_id=31109&func=browse
+
+Bugs in the debtorrent package should be reported using the reportbug
+program. If you're sure you've found a bug that's not in the debtorrent
+package (e.g. it's in the apt-transport-debtorrent program), you can
+report it to the [developer's mailing list][10].
+
+[30]: mailto:debtorrent-devel at lists.alioth.debian.org
+
+## Privacy
+
+The data described in the guidelines below should not be sensitive,
+though it will contain details of which packages you are trying to
+download. If you are very concerned about privacy, you may not want to
+attach these files to the bug report or submit them to the developer's
+mailing list. You can then send them directly to the lead developer:
+<camrdale at gmail.com>. Make sure to use the same subject line or include
+the bug number so the reports can be linked.
+
+## Guildelines
+
+The following guildelines are listed in order of importance, with the
+most important first.
+
+### Log Files
+
+The most useful information for finding and fixing bugs is found in the
+log files created by the DebTorrent client. These log files can be found
+in the /var/log/debtorrent/ directory. To get the most descriptive
+results, make sure the Debug logging level is set in the config file
+(which is the default). The log files may then grow quite big, so you
+may want to only submit the last 1000 lines or so of the log file (or
+whatever number captures the needed information, if uncertain err on the
+side of including too much). To do that, you may find this command
+useful:
+
+ tail -n 1000 /var/log/debtorrent/debtorrent-client.log | gzip > /tmp/debtorrent-client.log.gz
+
+### APT Debug Messages
+
+Most of the problems with DebTorrent will be noticed while using an
+apt-get command to update or download packages. Therefore, it can be
+very useful to see a detailed log of what APT is doing in order to
+diagnose the problem. To enable debugging in APT, add the following
+lines to your /etc/apt/apt.conf file:
+
+ Debug
+ {
+ pkgAcquire "true";
+ pkgAcquire::Worker "true";
+ Acquire::Debtorrent "true";
+ Acquire::Http "true";
+ }
+
+When running APT, save the resulting output to a file and submit it with
+the bug report.
+
+### Config Files
+
+Some of the configuration files used by the various programs may also be
+useful in diagnosing problems. Some of these config files include:
+
+* the debtorrent config files in /etc/debtorrent/
+* /etc/apt/sources.list
+* /etc/apt/apt.conf
Modified: website/trunk/FAQ.mdwn
URL: http://svn.debian.org/wsvn/debtorrent/website/trunk/FAQ.mdwn?rev=293&op=diff
==============================================================================
--- website/trunk/FAQ.mdwn (original)
+++ website/trunk/FAQ.mdwn Mon Sep 3 00:25:39 2007
@@ -8,8 +8,8 @@
All you need to get started is the [[debtorrent package|Install]]. To
improve the communication with APT, you may also want to install the
-apt-transport-debtorrent package (and maybe even a patched version of
-APT, [find out why][10]).
+[[apt-transport-debtorrent]] package (and maybe even a patched version
+of APT, [find out why][10]).
[10]: http://www.camrdale.org/blog/posts/Aug-19-2007.html
@@ -86,6 +86,8 @@
[30]: http://www.portforward.com/
[40]: http://www.canyouseeme.org/
+---
+
### Troubleshooting
#### Installing a package fails? No torrents are running?
@@ -99,7 +101,7 @@
DebTorrent. If the proper torrent's are running, then file a bug (see
[[BugReporting]])
-#### An `apt-get update` is stuck saying "Waiting for headers"?
+#### An apt-get update is stuck saying "Waiting for headers"?
Wait a bit to make sure it's actually stuck. The DebTorrent downloads
occur sequentially and can be quite slow. They also give no indication
@@ -110,3 +112,10 @@
determine which download is timing out (it may not be a DebTorrent
download, but just a stalled download from a slow mirror). See
[[BugReporting]] for how to enable debugging in APT.
+
+#### I got errors trying to download from experimental?
+
+The experimental suite is not currently supported by DebTorrent, and it
+is not recommended that you use DebTorrent to download packages from it.
+It may work fine for you, but it is untested. Future versions may have
+support for it, but it is not a high priority feature.
Modified: website/trunk/Install.mdwn
URL: http://svn.debian.org/wsvn/debtorrent/website/trunk/Install.mdwn?rev=293&op=diff
==============================================================================
--- website/trunk/Install.mdwn (original)
+++ website/trunk/Install.mdwn Mon Sep 3 00:25:39 2007
@@ -4,13 +4,16 @@
packages (.debs):
* *debtorrent*: the DebTorrent client and tracker
-* *apt-transport-debtorrent*: an advanced communication
+* *[[apt-transport-debtorrent]]*: an advanced communication
protocol for communicating with APT
-Since DebTorrent is not yet in the debian archive, you
-can download these packages from the [Alioth project][10],
+DebTorrent is available in the debian archive, so an
+`apt-get install debtorrent` should be all you need to get started.
+
+apt-transport-debtorrent is not yet available in the debian archive
+and can be downloaded from the [Alioth project][10],
or from my [personal repository][20]. To automatically get
-new versions of these packages, you can add my repository
+new versions of this package, you can add my repository
to your `/etc/apt/sources.list` by adding this line:
deb http://debian.camrdale.org/ unstable main contrib non-free
@@ -25,7 +28,7 @@
[30]: http://www.camrdale.org/blog/posts/Aug-19-2007.html
*apt-transport-debtorrent* is currently only available compiled
-for i386 and amd64 architectures. If you are on something else,
+for powerpc, i386 and amd64 architectures. If you are on something else,
you will need to compile it yourself (which should be straight
forward and not require any modifications).
Added: website/trunk/apt-transport-debtorrent.mdwn
URL: http://svn.debian.org/wsvn/debtorrent/website/trunk/apt-transport-debtorrent.mdwn?rev=293&op=file
==============================================================================
--- website/trunk/apt-transport-debtorrent.mdwn (added)
+++ website/trunk/apt-transport-debtorrent.mdwn Mon Sep 3 00:25:39 2007
@@ -1,0 +1,55 @@
+## apt-transport-debtorrent: <small>an advanced communication protocol
+for communicating with APT</small>
+
+apt-transport-debtorrent is a separate package that can be installed so
+that apt can use the `debtorrent://` method to communicate with the
+DebTorrent client. This is significantly faster than the traditional
+`http://` method, and in the future will contain additional features to
+improve the status updates shown by APT.
+
+### Features
+
+* sends all requests it receives from APT directly to the DebTorrent
+ client
+* allows the DebTorrent client to return files to APT in any order
+
+This software is open-source and is released at no charge under the
+terms of the [GPLv2 license][10] (which is different from the license
+of the DebTorrent program).
+
+[10]: http://opensource.org/licenses/gpl-license.php
+
+### Installation
+
+Installing apt-transport-debtorrent is covered on the [[Install]] page,
+along with the debtorrent package.
+
+If you think you've found a bug that is specifically in the debtorrent
+transport method (i.e. not in the DebTorrent client, whose bugs are
+reported using the reportbug program), you can report it to the
+[developer's mailing list][20]. Please try to follow the
+[[BugReporting]] guildelines for debugging APT.
+
+[20]: mailto:debtorrent-devel at lists.alioth.debian.org
+
+### Requirements
+
+* A network-accessible host running the DebTorrent client
+* A recent APT-based package management system (such as Debian
+ distributions have)
+
+### The Code
+
+The latest code for apt-transport-debtorrent is hosted in the same
+Subversion repository as DebTorrent. It is originally based on the
+code for APT's http transport method, with some modifications to support
+the new features. It is publicly readable, and requests for write access
+can be sent to the [developers mailing list][20].
+
+[30]: mailto:debtorrent-devel at lists.alioth.debian.org
+
+* svn://svn.debian.org/debtorrent/apt-transport-debtorrent/trunk (anonymous access)
+* <http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/> (web access)
+* [commit mailing list for the entire subversion repository][30]
+
+[40]: http://lists.alioth.debian.org/mailman/listinfo/debtorrent-commits
Modified: website/trunk/index.mdwn
URL: http://svn.debian.org/wsvn/debtorrent/website/trunk/index.mdwn?rev=293&op=diff
==============================================================================
--- website/trunk/index.mdwn (original)
+++ website/trunk/index.mdwn Mon Sep 3 00:25:39 2007
@@ -37,9 +37,10 @@
Development of this project is active and on-going, with several recent
releases and several planned upcoming ones. The current software is
-considered to be Alpha quality, as it has all of the desired features
-and does work, but it still has some bugs. Future updates will fix
-this.
+considered to be beta quality, as it has all of the desired features
+and has been tested to work well for most people. Future updates will
+add features to make the downloading more efficient and the program more
+user-friendly.
### Installing
@@ -47,18 +48,19 @@
program. If you have any trouble using the program, post a message or
question to the [developer mailing list][50], or come and find us in the
IRC channel (`#debtorrent` on [OFTC][60]). If you think you've found a
-bug in the program, open up a new bug report in the [Bug tracker][70].
+bug in the program, please report it using the standard reportbug
+program, and preferably following [[these guildelines|BugReporting]].
[50]: mailto:debtorrent-devel at lists.alioth.debian.org
[60]: http://irc.oftc.net
-[70]: http://alioth.debian.org/tracker/?atid=412875&group_id=31109&func=browse
### Contributing
-There is currently a small team of developers working hard to prepare
-the next release, but we could always use some help. Currently we are
-in need of new ideas and comments on old ones, testers, and developers
-familiar with APT. Feel free to update the website too, it's a wiki!
+There is currently a very small team of developers working hard to
+prepare the next release, but we could always use some help. Currently
+we are in need of new ideas and comments on old ones, testers, and
+developers familiar with APT. Feel free to update the website too, it's
+a wiki!
If you'd like to get involved or think you could help the project in
any way, please join the [developers mailing list][80].
@@ -94,3 +96,6 @@
[120]: http://lists.alioth.debian.org/mailman/listinfo/debtorrent-commits
Some documentation (API) for the code is [available here](api/).
+
+The related [[apt-transport-debtorrent]] package also has code in the
+same Subversion reposiory.
More information about the Debtorrent-commits
mailing list