Note that using the old sockets API probably will not work
[rsync/rsync.git] / TODO
diff --git a/TODO b/TODO
index 7acbd3c..7984031 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,6 +2,13 @@
 
 BUGS ---------------------------------------------------------------
 
+rsync-url barfs on upload
+
+  rsync foo rsync://localhost/transfer/
+
+  Fix the parser.
+
+
 There seems to be a bug with hardlinks
 
   mbp/2 build$ ls -l /tmp/a /tmp/b -i
@@ -73,6 +80,49 @@ There seems to be a bug with hardlinks
   -rw-rw-r--    5 mbp      mbp            29 Mar 25 17:30 b3
 
 
+Progress indicator can produce corrupt output when transferring directories:
+
+  main/binary-arm/
+  main/binary-arm/admin/
+  main/binary-arm/base/
+  main/binary-arm/comm/8.56kB/s    0:00:52
+  main/binary-arm/devel/
+  main/binary-arm/doc/
+  main/binary-arm/editors/
+  main/binary-arm/electronics/s    0:00:53
+  main/binary-arm/games/
+  main/binary-arm/graphics/
+  main/binary-arm/hamradio/
+  main/binary-arm/interpreters/
+  main/binary-arm/libs/6.61kB/s    0:00:54
+  main/binary-arm/mail/
+  main/binary-arm/math/
+  main/binary-arm/misc/
+
+lchmod
+  I don't think we handle this properly on systems that don't have the
+  call.
+
+Cross-test versions
+  Part of the regression suite should be making sure that we don't
+  break backwards compatibility: old clients vs new servers and so
+  on.  Ideally we would test the cross product of versions.  
+
+  It might be sufficient to test downloads from well-known public
+  rsync servers running different versions of rsync.  This will give
+  some testing and also be the most common case for having different
+  versions and not being able to upgrade.
+
+--no-blocking-io might be broken
+
+  in the same way as --no-whole-file; somebody needs to check.
+
+Do not rely on having a group called "nobody"
+
+  http://www.linuxbase.org/spec/refspecs/LSB_1.1.0/gLSB/usernames.html
+
+  On Debian it's "nogroup"
+
 DAEMON --------------------------------------------------------------
 
 server-imposed bandwidth limits
@@ -114,6 +164,13 @@ use chroot
   command or a script.
 
 
+supplementary groups
+
+  Perhaps allow supplementary groups to be specified in rsyncd.conf;
+  then make the first one the primary gid and all the rest be
+  supplementary gids.
+
+
 File list structure in memory
 
   Rather than one big array, perhaps have a tree in memory mirroring
@@ -256,6 +313,22 @@ Hard-link handling
 
 IPv6
 
+  Perhaps put back the old socket code; if on a machine that does not
+  properly support the getaddrinfo API, then use it.  This is probably
+  much simpler than reimplementing it.
+
+  Alternatively, have two different files implementing the same
+  interface, and choose either the new or the old API.  This is
+  probably necessary for systems that e.g. have IPv6, but
+  gethostbyaddr() can't handle it.  The Linux manpage claims this is
+  currently the case.
+
+  This might get us working again on RedHat 5 and similar systems.
+  Although the Kame patch seems like a good idea, in fact it is a much
+  broader interface than the relatively narrow "open by name", "accept
+  and log" interface that rsync uses internally, and it has the
+  disadvantage of clashing with half-arsed implementations of the API.
+
   Implement suggestions from http://www.kame.net/newsletter/19980604/
   and ftp://ftp.iij.ad.jp/pub/RFC/rfc2553.txt
 
@@ -352,11 +425,21 @@ logging
 
   Keep stderr and stdout properly separated (Debian #23626)
 
-  Use a separate function for reporting errors; prefix it with
-  "rsync:" or "rsync(remote)", or perhaps even "rsync(local
-  generator): ".
+  After we get the @RSYNCD greeting from the server, we know it's
+  version but we have not yet sent the command line, so we could just
+  remove the -z option if the server is too old.  
+
+  For ssh invocation it's not so simple, because we actually use the
+  command line to start the remote process.  However, we only actually
+  do compression in token.c, and we could therefore once we discover
+  the remote version emit an error if it's too old.  I'm not sure if
+  that's a good tradeoff or not.
 
 
+rsyncd over ssh
+
+  There are already some patches to do this.
+
 proxy authentication
 
   Allow RSYNC_PROXY to be http://user:pass@proxy.foo:3128/, and do
@@ -370,6 +453,16 @@ SOCKS
   Add --with-socks, and then perhaps a command-line option to put them
   on or off.  This might be more reliable than LD_PRELOAD hacks.
 
+FAT support
+
+  rsync to a FAT partition on a Unix machine doesn't work very well
+  at the moment.  I think we get errors about invalid filenames and 
+  perhaps also trying to do atomic renames.
+
+  I guess the code to do this is currently #ifdef'd on Windows; perhaps
+  we ought to intelligently fall back to it on Unix too.
+
+
 Better statistics:
 
   <Rasmus> mbp: hey, how about an rsync option that just gives you the
@@ -415,6 +508,8 @@ chmod:
   the program.  For bonus points there would be a test case for the  
   parser.
 
+  Possibly also --chown
+
   (Debian #23628)
 
 
@@ -445,13 +540,36 @@ Check "refuse options works"
   Was this broken when we changed to popt?
 
 
+PERFORMANCE ----------------------------------------------------------
+
+MD4 file_sum
+
+  If we're doing a local transfer, or using -W, then perhaps don't
+  send the file checksum.  If we're doing a local transfer, then
+  calculating MD4 checksums uses 90% of CPU and is unlikely to be
+  useful.
+
+  Indeed for transfers over zlib or ssh we can also rely on the
+  transport to have quite strong protection against corruption.
+
+  Perhaps we should have an option to disable this, analogous to
+  --whole-file, although it would default to disabled.  The file
+  checksum takes up a definite space in the protocol -- we can either
+  set it to 0, or perhaps just leave it out.
+
+MD4
+
+  Perhaps borrow an assembler MD4 from someone?
+
+  Make sure we call MD4 with properly-sized blocks whenever possible
+  to avoid copying into the residue region?
+
 String area code
 
   Test whether this is actually faster than just using malloc().  If
   it's not (anymore), throw it out.
          
 
-
 PLATFORMS ------------------------------------------------------------
 
 Win32
@@ -467,6 +585,7 @@ Win32
   we are correct to call close(), because shutdown() discards
   untransmitted data.
 
+
 DEVELOPMENT ----------------------------------------------------------
 
 Splint
@@ -492,19 +611,50 @@ Memory debugger
 
     http://devel-home.kde.org/~sewardj/
 
+Release script
+  
+  Update spec files
+
+  Build tar file; upload
+
+  Send announcement to mailing list and c.o.l.a.
+  
+  Make freshmeat announcement
+
+  Update web site
+
+
+
 TESTING --------------------------------------------------------------
 
 Cross-test versions
 
   Part of the regression suite should be making sure that we don't
   break backwards compatibility: old clients vs new servers and so
-  on.  Ideally we would test the cross product of versions.  
+  on.  Ideally we would test both up and down from the current release
+  to all old versions.
+
+  We might need to omit broken old versions, or versions in which
+  particular functionality is broken
 
   It might be sufficient to test downloads from well-known public
   rsync servers running different versions of rsync.  This will give
   some testing and also be the most common case for having different
   versions and not being able to upgrade.
 
+
+Test on kernel source
+
+  Download all versions of kernel; unpack, sync between them.  Also
+  sync between uncompressed tarballs.  Compare directories after
+  transfer.
+
+  Use local mode; ssh; daemon; --whole-file and --no-whole-file.
+
+  Use awk to pull out the 'speedup' number for each transfer.  Make
+  sure it is >= x.
+
+
 Test large files
 
   Sparse and non-sparse
@@ -526,6 +676,12 @@ Versions of read() and write() that corrupt the stream, or abruptly fail
 Separate makefile target to run rough tests -- or perhaps just run
 them every time?
 
+Test "refuse options" works
+
+  What about for --recursive?
+
+  If you specify an unrecognized option here, you should get an error.
+
 
 DOCUMENTATION --------------------------------------------------------
 
@@ -535,6 +691,19 @@ Keep list of open issues and todos on the web site
 
 Update web site from CVS
 
+
+Perhaps redo manual as SGML
+
+  The man page is getting rather large, and there is more information
+  that ought to be added.
+
+  TexInfo source is probably a dying format.
+
+  Linuxdoc looks like the most likely contender.  I know DocBook is
+  favoured by some people, but it's so bloody verbose, even with emacs
+  support.
+
+
 BUILD FARM -----------------------------------------------------------
 
 Add machines
@@ -547,15 +716,24 @@ Add machines
 
   SCO
 
-NICE -----------------------------------------------------------------
 
---no-detach and --no-fork options
+LOGGING --------------------------------------------------------------
 
-  Very useful for debugging.  Also good when running under a
-  daemon-monitoring process that tries to restart the service when the
-  parent exits.
+  Perhaps flush stdout after each filename, so that people trying to
+  monitor progress in a log file can do so more easily.  See
+  http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=48108
 
-hang/timeout friendliness
+  At the connections that just get a list of modules are not logged,
+  but they should be.
+
+  If a child of the rsync daemon dies with a signal, we should notice
+  that when we reap it and log a message.
+
+  Keep stderr and stdout properly separated (Debian #23626)
+
+  Use a separate function for reporting errors; prefix it with
+  "rsync:" or "rsync(remote)", or perhaps even "rsync(local
+  generator): ".
 
 verbose output
   
@@ -564,6 +742,27 @@ verbose output
   At end of transfer, show how many files were or were not transferred
   correctly.
 
+-vv
+
+  Explain *why* every file is transferred or not (e.g. "local mtime
+  123123 newer than 1283198")
+
+
+debugging of daemon
+
+  Add an rsyncd.conf parameter to turn on debugging on the server.
+
+
+
+NICE -----------------------------------------------------------------
+
+--no-detach and --no-fork options
+
+  Very useful for debugging.  Also good when running under a
+  daemon-monitoring process that tries to restart the service when the
+  parent exits.
+
+hang/timeout friendliness
 
 internationalization
 
@@ -576,7 +775,6 @@ internationalization
   get the manual translated first, because that's possibly more useful
   and at any rate demonstrates desire.
 
-
 rsyncsh 
 
    Write a small emulation of interactive ftp as a Pythonn program
@@ -584,3 +782,21 @@ rsyncsh
    fairly directly into rsync commands: it just needs to remember the
    current host, directory and so on.  We can probably even do
    completion of remote filenames.
+
+
+RELATED PROJECTS -----------------------------------------------------
+
+http://rsync.samba.org/rsync-and-debian/
+
+rsyncable gzip patch
+
+  Exhaustive, tortuous testing
+
+  Cleanups?
+
+rsyncsplit as alternative to real integration with gzip?
+
+reverse rsync over HTTP Range
+
+  Goswin Brederlow suggested this on Debian; I think tridge and I
+  talked about it previous in relation to rproxy.