r297 - in /debtorrent/trunk: README.txt TODO debian/changelog

camrdale-guest at users.alioth.debian.org camrdale-guest at users.alioth.debian.org
Sun Oct 14 21:36:51 UTC 2007


Author: camrdale-guest
Date: Sun Oct 14 21:36:51 2007
New Revision: 297

URL: http://svn.debian.org/wsvn/debtorrent/?sc=1&rev=297
Log:
* Word wrap some documentation at 80 columns (Closes: #445676)

Modified:
    debtorrent/trunk/README.txt
    debtorrent/trunk/TODO
    debtorrent/trunk/debian/changelog

Modified: debtorrent/trunk/README.txt
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/trunk/README.txt?rev=297&op=diff
==============================================================================
--- debtorrent/trunk/README.txt (original)
+++ debtorrent/trunk/README.txt Sun Oct 14 21:36:51 2007
@@ -1,57 +1,59 @@
 To start using DebTorrent, do the following:
 
-1. 	Install the package, either from the Debian archive, or from the binary at:
+1. 	Install the package, either from the Debian archive, or from the 
+    binary at:
 
    	https://alioth.debian.org/frs/?group_id=31109
 
-2.	Modify your /etc/apt/sources.list to send all requests through the debtorrent
-	program, for example if your sources.list contains a line like this:
+2.  Modify your /etc/apt/sources.list to send all requests through the 
+    debtorrent program, for example if your sources.list contains a line 
+    like this:
 
-	deb http://ftp.us.debian.org/debian etch main contrib non-free
+    deb http://ftp.us.debian.org/debian etch main contrib non-free
 
-	then replace it with this (add "localhost:9988/" to the beginning):
+    then replace it with this (add "localhost:9988/" to the beginning):
 
-	deb http://localhost:9988/ftp.us.debian.org/debian etch main contrib non-free
+    deb http://localhost:9988/ftp.us.debian.org/debian etch main contrib non-free
 	
-	The port can be changed by the "apt_port" option to debtorrent-client
-	in the /etc/debtorrent/debtorrent-client.conf file, but it defaults to
-	9988.
+    The port can be changed by the "apt_port" option to 
+    debtorrent-client in the /etc/debtorrent/debtorrent-client.conf 
+    file, but it defaults to 9988.
 
-3. 	Update your package lists (as root):
+3.  Update your package lists (as root):
 
-   	apt-get update
+    apt-get update
    	
-   	This will download the Packages files through the debtorrent program, which
-   	will automatically start them running. You should be able to see some 
-	indication of this by going to 
+    This will download the Packages files through the debtorrent 
+    program, which will automatically start them running. You should be 
+    able to see some indication of this by going to 
 
-	http://localhost:9988/
+    http://localhost:9988/
 
-	in your web browser.
+    in your web browser.
 
-4. 	Proceed to use apt normally (as root), for example:
+4.  Proceed to use apt normally (as root), for example:
 
-	apt-get install ...
-	apt-get upgrade
-	apt-get dist-upgrade
+    apt-get install ...
+    apt-get upgrade
+    apt-get dist-upgrade
 
-	All downloads through Apt should work, regardless if there are any peers,
-	since the program will use a backup HTTP download from the mirror in the
-	event that no peers for the download can be found.
+    All downloads through Apt should work, regardless if there are any 
+    peers, since the program will use a backup HTTP download from the 
+    mirror in the event that no peers for the download can be found.
 
-	If you can't download, or if you get errors from running any of the 
-	programs, please post the problem/error to:
+    If you can't download, or if you get errors from running any of the 
+    programs, please post the problem/error to:
 	
-		debtorrent-devel at lists.alioth.debian.org
+        debtorrent-devel at lists.alioth.debian.org
 
 
 Known Bugs
 ----------
 
-On stopping the client using the init script in /etc/init.d, the following
-warning is generated:
+On stopping the client using the init script in /etc/init.d, the 
+following warning is generated:
 
-	start-stop-daemon: warning: failed to kill 10699: No such process
+    start-stop-daemon: warning: failed to kill 10699: No such process
 
-The warning has no effect on the stopping of the client, which should be
-stopped when this warning is printed. See bug #157305 for more info.
+The warning has no effect on the stopping of the client, which should 
+be stopped when this warning is printed. See bug #157305 for more info.

Modified: debtorrent/trunk/TODO
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/trunk/TODO?rev=297&op=diff
==============================================================================
--- debtorrent/trunk/TODO (original)
+++ debtorrent/trunk/TODO Sun Oct 14 21:36:51 2007
@@ -3,94 +3,98 @@
 
 Don't ignore Packages.diff
 
-Currently requests for Packages.diff return a 404 not found error, as the 
-AptListener doesn't yet know how to process these. This should be improved to 
-store a cached copy of the Packages file, and apply the diffs to it as they 
-download, then use the final file as the torrent file. Security checking of
-the hashes of the diffs or the final file may be necessary.
+Currently requests for Packages.diff return a 404 not found error, as 
+the AptListener doesn't yet know how to process these. This should be 
+improved to store a cached copy of the Packages file, and apply the 
+diffs to it as they download, then use the final file as the torrent 
+file. Security checking of the hashes of the diffs or the final file may 
+be necessary.
 
 
-Check if the torrent is already running before getting it from the cache
+Check if the torrent is already running before getting from the cache
 
-When a Packages download results in a 304 not modified message because the
-file is in the cache and up to date with the server, the Packages file
-still needs to be uncompressed and turned into a torrent to determine if it
-is currently running or not. This is time consuming and unnecessary. A better
-solution is to store some information about which Packages files belong to 
-which running torrents, and then check that.
+When a Packages download results in a 304 not modified message because 
+the file is in the cache and up to date with the server, the Packages 
+file still needs to be uncompressed and turned into a torrent to 
+determine if it is currently running or not. This is time consuming and 
+unnecessary. A better solution is to store some information about which 
+Packages files belong to which running torrents, and then check that.
 
 
 Check for problems with the experimental saveas_style 2 
 
-Using the saveas_style = 2 option saves the files downloaded from the torrents
-in the same directory structure as the files downloaded by proxy. This is more
-efficient, since the files can be retrieved by the cacher without having to
-check the running torrents for them. However, it could also cause problems if
-the file has not yet completed downloading (will fail hash check). Some
-investigation needs to be done of the possiblity of this and how best to check
-for it.
+Using the saveas_style = 2 option saves the files downloaded from the 
+torrents in the same directory structure as the files downloaded by 
+proxy. This is more efficient, since the files can be retrieved by the 
+cacher without having to check the running torrents for them. However, 
+it could also cause problems if the file has not yet completed 
+downloading (will fail hash check). Some investigation needs to be done 
+of the possiblity of this and how best to check for it.
 
 
-AptListener queue waiting for downloads should be implemented using callbacks
+AptListener queue waiting for downloads should be using callbacks
 
-AptListener currently queues requests for packages that have not completed
-downloading, and then checks this queue every 1 second. This could be made 
-more efficient by adding callbacks to PiecePicker or StorageWrapper, so that
-when a piece comes in and passes the hash check, then the AptListener will
-process any queued requests for that piece.
+AptListener currently queues requests for packages that have not 
+completed downloading, and then checks this queue every 1 second. This 
+could be made more efficient by adding callbacks to PiecePicker or 
+StorageWrapper, so that when a piece comes in and passes the hash check, 
+then the AptListener will process any queued requests for that piece.
 
 
 Different forms of HTTP Downloading may open too many connections
 
-There are a lot of different ways for the program to download from a mirror,
-including the HTTPDownloader for pieces (one per torrent), the HTTPCache
-downloader (one per program), etc... Most are threaded, and could end up
-opening a lot of connections to a single mirror. A better implementation 
-would be to manage these connections all in one place, so that they can be
-controlled together and a max number of connections could be set.
+There are a lot of different ways for the program to download from a 
+mirror, including the HTTPDownloader for pieces (one per torrent), the 
+HTTPCache downloader (one per program), etc... Most are threaded, and 
+could end up opening a lot of connections to a single mirror. A better 
+implementation would be to manage these connections all in one place, 
+so that they can be controlled together and a max number of connections 
+could be set.
 
 
 Make the URL download better
 
-The URL download is currently a little hacky, and could be improved. The 
-urlopen class could be made into an iterator, and could decompress files with 
-the ".gz" extension itself.
+The URL download is currently a little hacky, and could be improved. 
+The  urlopen class could be made into an iterator, and could decompress 
+files with the ".gz" extension itself.
 
 
 Pre-allocating files is necessary
 
-In order for the download to work properly, the allocation method must be set to 
-pre-allocate (normal doesn't work, the others probably don't). This is due to 
-the pieces no longer being the same size, and so data cannot be moved around 
-between them like it was previously. This may not be an issue after a maximum 
-piece size is introduced, though pre-allocation may still be necessary to serve 
-downloaded files while other downloads continue. Pre-allocation with priorities 
-enabled does not pre-allocate the entire archive. Later, when multiple pieces per 
+In order for the download to work properly, the allocation method must 
+be set to pre-allocate (normal doesn't work, the others probably don't). 
+This is due to the pieces no longer being the same size, and so data 
+cannot be moved around between them like it was previously. This may not 
+be an issue after a maximum piece size is introduced, though 
+pre-allocation may still be necessary to serve downloaded files while 
+other downloads continue. Pre-allocation with priorities enabled does 
+not pre-allocate the entire archive. Later, when multiple pieces per 
 file are used, an allocation method could be used within a file.
 
 
 Statistics for the swarm are incorrect
 
-The statistics for file completion in the swarm are incorrect. This is due to 
-using the number of pieces each peer has as a measure of their completion. Since 
-some pieces are very small, and some very large, this is no longer accurate. 
-This may not need fixing though, as piece sizes will become more uniform in 
-later versions, and these statistics may not be needed.
+The statistics for file completion in the swarm are incorrect. This is 
+due to using the number of pieces each peer has as a measure of their 
+completion. Since some pieces are very small, and some very large, this 
+is no longer accurate. This may not need fixing though, as piece sizes 
+will become more uniform in later versions, and these statistics may not 
+be needed.
 
 
 Switch to using the poll() system call instead of the select module
 
 The poll() system call, supported on most Unix systems, provides better 
-scalability for network servers that service many, many clients at the same 
-time. poll() scales better because the system call only requires listing the 
-file descriptors of interest, while select() builds a bitmap, turns on bits 
-for the fds of interest, and then afterward the whole bitmap has to be 
-linearly scanned again. select() is O(highest file descriptor), while poll() 
-is O(number of file descriptors).
+scalability for network servers that service many, many clients at the 
+same time. poll() scales better because the system call only requires 
+listing the file descriptors of interest, while select() builds a 
+bitmap, turns on bits for the fds of interest, and then afterward the 
+whole bitmap has to be linearly scanned again. select() is O(highest 
+file descriptor), while poll() is O(number of file descriptors).
 
 
 Consider Sources
 
-Sources files contain 2 or 3 files for every source package, but no SHA1 sums 
-for any of them. These sums would have to be generated, or preferably sub-file 
-sums, before anything can be done.
+Sources files contain 2 or 3 files for every source package, but no 
+SHA1 sums for any of them. These sums would have to be generated, or 
+preferably sub-file sums, before anything can be done.

Modified: debtorrent/trunk/debian/changelog
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/trunk/debian/changelog?rev=297&op=diff
==============================================================================
--- debtorrent/trunk/debian/changelog (original)
+++ debtorrent/trunk/debian/changelog Sun Oct 14 21:36:51 2007
@@ -1,6 +1,7 @@
 debtorrent (0.1.4.2) unstable; urgency=low
 
   * Add logrotate file (Closes: #440510, #446297)
+  * Word wrap some documentation at 80 columns (Closes: #445676)
 
  -- Cameron Dale <camrdale at gmail.com>  Sun, 14 Oct 2007 14:13:00 -0700
 




More information about the Debtorrent-commits mailing list