Note error cases that we ought to improve.
[rsync/rsync.git] / TODO
1 -*- indented-text -*-
2
3 URGENT ---------------------------------------------------------------
4
5
6 IMPORTANT ------------------------------------------------------------
7
8 Cross-test versions
9
10   Part of the regression suite should be making sure that we don't
11   break backwards compatibility: old clients vs new servers and so
12   on.  Ideally we would test the cross product of versions.  
13
14   It might be sufficient to test downloads from well-known public
15   rsync servers running different versions of rsync.  This will give
16   some testing and also be the most common case for having different
17   versions and not being able to upgrade.
18
19 use chroot
20
21   If the platform doesn't support it, then don't even try.
22
23   If running as non-root, then don't fail, just give a warning.
24   (There was a thread about this a while ago?)
25
26     http://lists.samba.org/pipermail/rsync/2001-August/thread.html
27     http://lists.samba.org/pipermail/rsync/2001-September/thread.html
28
29 --files-from
30
31   Avoids traversal.  Better option than a pile of --include statements
32   for people who want to generate the file list using a find(1)
33   command or a script.
34
35 Performance
36
37   Traverse just one directory at a time.  Tridge says it's possible.
38  
39   Can possibly also be smarter about memory use while looking for hard
40   links by reducing the refcount as we find alternative names.
41
42 IPv6
43
44   Define a syntax for IPv6 literal addresses.  Since they include
45   colons, they tend to break most naming systems, including ours.
46   Based on the HTTP IPv6 syntax, I think we should use
47  
48      rsync://[::1]/foo/bar
49      [::1]::bar
50
51   which should just take a small change to the parser code.
52
53 Errors
54
55   If we hang or get SIGINT, then explain where we were up to.  Perhaps
56   have a static buffer that contains the current function name, or
57   some kind of description of what we were trying to do.  This is a
58   little easier on people than needing to run strace/truss.
59
60   "The dungeon collapses!  You are killed."  Rather than "unexpected
61   eof" give a message that is more detailed if possible and also more
62   helpful.  
63
64
65 PLATFORMS ------------------------------------------------------------
66
67 Win32
68
69   Don't detach, because this messes up --srvany.
70
71   http://sources.redhat.com/ml/cygwin/2001-08/msg00234.html
72
73   According to "Effective TCP/IP Programming" (??) close() on a socket
74   has incorrect behaviour on Windows -- it sends a RST packet to the
75   other side, which gives a "connection reset by peer" error.  On that
76   platform we should probably do shutdown() instead.  However, on Unix
77   we are correct to call close(), because shutdown() discards
78   untransmitted data.
79
80 BUILD FARM -----------------------------------------------------------
81
82 Add machines
83
84   AMDAHL UTS (Dave Dykstra)
85
86   Cygwin (on different versions of Win32?)
87
88   HP-UX variants (via HP?)
89
90   SCO
91
92 NICE -----------------------------------------------------------------
93
94 --no-detach and --no-fork options
95
96   Very useful for debugging.  Also good when running under a
97   daemon-monitoring process that tries to restart the service when the
98   parent exits.
99
100 hang/timeout friendliness
101
102   On 
103
104 internationalization
105
106   Change to using gettext().  Probably need to ship this for platforms
107   that don't have it.  
108
109   Solicit translations.
110
111   Does anyone care?
112
113 rsyncsh 
114
115    Write a small emulation of interactive ftp as a Pythonn program
116    that calls rsync.  Commands such as "cd", "ls", "ls *.c" etc map
117    fairly directly into rsync commands: it just needs to remember the
118    current host, directory and so on.  We can probably even do
119    completion of remote filenames.
120