Added a note to the "maybe by 0.44" list to prune sfdisk and graft fdisk.
[oweals/busybox.git] / TODO
1 TODO list for busybox in no particular order. Just because something
2 is listed here doesn't mean that it is going to be added to busybox,
3 or that doing so is even a good idea. It just means that I _might_ get
4 around to it some time. If you have any good ideas, please let me know.
5
6 * login/sulogin/passwd/getty/etc are part of tinylogin, and so are not
7     needed or wanted in busybox (or else I'd have to link to libcrypt).
8
9 * Networking apps are probably going to be split out some time soon into a
10     separate package (named perhaps netkit-tiny?).  This would remove the
11     following items from BusyBox: hostid, hostname, nc, nslookup, telnet, 
12     and ping.  nfs mounting and syslogd (when it supports network logging)
13     will remain in BusyBox.
14
15  -Erik
16
17 -----------
18
19 Bugs that need fixing before the 0.44 release goes out the door:
20
21  - "more" doesn't accept " " to scroll by one page when BB_FEATURE_USE_TERMIOS
22     is not on.
23  - doc / website updates to tell what the real mailing list is for busybox.
24  - fix 'cp' (or test suite script) so that it passes the test suite.
25  - merge Pavel's rm fixes.
26
27 These could get done before the 0.44 release if we have time, but we won't
28 hold up the 0.44 release just because of these:
29
30  - ps dirent race bug (need to stat the file before attempting chdir)
31  - Make 'ln -s /tmp/file .' work the way GNU ln does (i.e. makes a link to 
32     /tmp/file in the current directory, rather then trying and failing to create
33     a symlink named "." in the current working directory).
34  - Prune sfdisk
35  - Graft fdisk
36
37 These will be deferred til after 0.44 is released. We will rework these to use
38 libc regex functions instead (as per the mailing list discussion):
39
40  - 'grep foo$ file' doesn't work
41  - 'grep *foo file' segfaults
42
43
44 -----------
45
46 * Make insmod actually work
47 * dnsdomainname
48 * traceroute/netstat
49 * rdate
50 * hwclock
51 * stty
52 * expr
53 * wget (or whatever I call it)
54 * tftp
55 * ftp
56 * group/commonize strings, remove dups (for i18n, l10n)
57 * consider making a unified option parser (if it can be done modular, small, etc.) 
58
59 -----------------------
60
61 Running the following:
62
63     rm -f busybox && make LDFLAGS+=-nostdlib 2>&1 | \
64         sed -ne 's/.*undefined reference to `\(.*\)..*/\1/gp' | sort | uniq
65
66 reveals the list of all external (i.e. libc) things that BusyBox depends on.
67 It would be a very nice thing to reduce this list to an absolute minimum, and
68 then create a microLibc to provide these functions.  There is no good reason
69 for GNU libc to be so big.  I'm sure it can be a lot better.
70
71 (BTW, this is more informative if BB_FEATURE_NFSMOUNT is turned off...)
72
73 Most wanted list:
74
75     [andersen@slag busybox]$ grep -l getgroups *.[ch]
76     test.c
77
78 Policy violation.  getgroups uses libc nss, which is unlikely
79 to be present in an embedded system.
80
81 To be replaced with a busybox local glob routine:
82
83     [andersen@slag busybox]$ grep -l glob *.[ch]
84     gunzip.c
85     gzip.c
86     sh.c
87     tar.c
88     telnet.c
89
90 Can check_wildcard_match() from utility.c do this job?
91
92
93 -----------------------
94
95 Compile with debugging on, run 'nm --size-sort ./busybox'
96 and then start with the biggest things and make them smaller...
97
98 -----------------------
99
100 busybox.defs.h is too big and hard to follow.
101
102 Perhaps I need to add a better build system (like the Linux kernel?)
103
104 -----------------------
105
106 Feature request:
107
108 /bin/busybox --install -s    which makes all links to commands that it
109   can support (an optionnal -s should be used for symbolic links instead
110   of hard links).
111
112 -----------------------
113
114
115 > Have you ever thought of doig network logging in busybox syslogd ? It
116 > would quite make sense on embedded systems... :)
117
118 So far I had not considered it.  Basically, you wish to have
119 messages from the embedded box logged to a remote network
120 syslog box, right?  I can see that this would be useful.
121 I'll add this to the TODO list,
122
123
124 -----------------------
125
126
127  I think that the add_inode &c in utility.c needs to also stow the
128  st_dev field, and that du.c should NOT call `reset_inode_list'
129  because there can be hard links from inside one argv/ to inside
130  another argv/.  du.c probably ought to have an -x switch like GNU du
131  does also...
132
133
134 ------------------------------------------------------------------
135
136 An interesting email listing some apps that use /proc.  BusyBox
137 tries to avoid /proc as mush as is possible, so this stuff is
138 interesting (to me at least):
139
140
141 Date:   Fri, 25 Feb 2000 08:23:12 +0000 (GMT)
142 From: Riley Williams <rhw@MemAlpha.CX>
143 X-Sender: rhw@moo.cus.org.uk
144 To: almesber@lrc.di.epfl.ch
145 Cc: "Albert D. Cahalan" <acahalan@cs.uml.edu>,
146         Linux Kernel <linux-kernel@vger.rutgers.edu>
147 Subject: Re: What /proc should contain [was: /proc/driver/microcode]
148 In-Reply-To: <20000224165245.A29790@lrc.di.epfl.ch>
149 Message-ID: <Pine.LNX.4.21.0002250806220.8741-100000@moo.cus.org.uk>
150 Sender: owner-linux-kernel@vger.rutgers.edu
151 Precedence: bulk
152
153 Hi there.
154
155  >> Nope, most /proc access is does via programs written in C.
156
157  > That varies a lot from file to file. E.g. I haven't seen any
158  > programs that are specificly designed to read /proc/atm/* yet,
159  > and I know of only one (fuser) that reads /proc/mounts,
160  > extracting only partial information (just to pick two examples
161  > that I'm quite familiar with).
162
163 As a point of reference, here's a slightly tweaked analysis of the
164 programs on the system I'm reading your mail on. Basically, I ran the
165 following script...
166
167  Q> #!/bin/bash
168  Q> function use() {
169  Q>     for Z in $* ; do
170  Q>         strings $Z | grep /proc | sed "s=^=$Z ="
171  Q>     done
172  Q> }
173  Q> use /{,s}bin/* /usr/{,s}bin/* | sort -u | tee proc-usage
174
175 ...and then went through it removing comments and print format
176 strings. Replace /proc with /dev and you'd soon have an equivalent
177 list for that - although I can report that such is MUCH larger...
178
179 There are three programs therein that refer to /proc/mounts ...
180
181         /bin/mount
182         /bin/umount
183         /usr/bin/eject
184
185 ...and, as you stated, none that refer to /proc/atm on this system.
186 However, as this is a RedHat Linux 5.0 based system, that's not
187 necessarily an up to date reference thereto...
188
189 Here's the list anyway...
190
191 /bin/kill /proc/%d/cmdline
192 /bin/kill /proc/%d/stat
193
194 /bin/mount /proc/devices
195 /bin/mount /proc/filesystems
196 /bin/mount /proc/mounts
197
198 /bin/netstat /proc/net
199 /bin/netstat /proc/net/appletalk
200 /bin/netstat /proc/net/ax25
201 /bin/netstat /proc/net/ax25_route
202 /bin/netstat /proc/net/dev
203 /bin/netstat /proc/net/ip_masquerade
204 /bin/netstat /proc/net/ipx
205 /bin/netstat /proc/net/ipx_route
206 /bin/netstat /proc/net/netstat
207 /bin/netstat /proc/net/nr
208 /bin/netstat /proc/net/nr_neigh
209 /bin/netstat /proc/net/nr_nodes
210 /bin/netstat /proc/net/raw
211 /bin/netstat /proc/net/route
212 /bin/netstat /proc/net/rt_cache
213 /bin/netstat /proc/net/snmp
214 /bin/netstat /proc/net/tcp
215 /bin/netstat /proc/net/udp
216 /bin/netstat /proc/net/unix
217
218 /bin/umount /proc/devices
219 /bin/umount /proc/mounts
220
221 /sbin/arp /proc/net/appletalk
222 /sbin/arp /proc/net/arp
223 /sbin/arp /proc/net/ax25
224 /sbin/arp /proc/net/ipx
225 /sbin/arp /proc/net/nr
226 /sbin/arp /proc/net/unix
227
228 /sbin/cardctl /proc/devices
229
230 /sbin/cardmgr /proc/devices
231
232 /sbin/fdisk /proc/ide/%s/media
233 /sbin/fdisk /proc/scsi/scsi
234
235 /sbin/getty /proc/version
236
237 /sbin/ifconfig /proc/net
238 /sbin/ifconfig /proc/net/appletalk
239 /sbin/ifconfig /proc/net/ax25
240 /sbin/ifconfig /proc/net/dev
241 /sbin/ifconfig /proc/net/ipx
242 /sbin/ifconfig /proc/net/nr
243 /sbin/ifconfig /proc/net/unix
244
245 /sbin/ifup /proc/sys/kernel/modprobe
246
247 /sbin/ipchains /proc/net/ip_fwchains
248 /sbin/ipchains /proc/net/ip_fwnames
249 /sbin/ipchains /proc/net/ip_masquerade
250 /sbin/ipchains /proc/sys/net/ipv4/ip_forward
251
252 /sbin/ipmaddr /proc/net/dev_mcast
253 /sbin/ipmaddr /proc/net/igmp
254 /sbin/ipmaddr /proc/net/igmp6
255
256 /sbin/iptunnel /proc/net/dev
257
258 /sbin/killall5 /proc/%s/cmdline
259 /sbin/killall5 /proc/%s/exe
260 /sbin/killall5 /proc/%s/stat
261 /sbin/killall5 /proc/version
262
263 /sbin/klogd /proc/kmsg
264
265 /sbin/lsmod /proc/modules
266
267 /sbin/modprobe /proc/modules
268
269 /sbin/pidof /proc/%s/cmdline
270 /sbin/pidof /proc/%s/exe
271 /sbin/pidof /proc/%s/stat
272 /sbin/pidof /proc/version
273
274 /sbin/probe /proc/pci
275
276 /sbin/rarp /proc/net/ax25
277 /sbin/rarp /proc/net/nr
278 /sbin/rarp /proc/net/rarp
279
280 /sbin/rmmod /proc/modules
281
282 /sbin/rmmod.static /proc/modules
283
284 /sbin/route /proc/net/appletalk
285 /sbin/route /proc/net/ax25
286 /sbin/route /proc/net/ax25_route
287 /sbin/route /proc/net/ipx
288 /sbin/route /proc/net/ipx_route
289 /sbin/route /proc/net/nr
290 /sbin/route /proc/net/nr_neigh
291 /sbin/route /proc/net/nr_nodes
292 /sbin/route /proc/net/route
293 /sbin/route /proc/net/rt_cache
294 /sbin/route /proc/net/unix
295
296 /sbin/scsi_info /proc/scsi
297 /sbin/scsi_info /proc/scsi/%s
298 /sbin/scsi_info /proc/scsi/scsi
299
300 /sbin/slattach /proc/net/ax25
301 /sbin/slattach /proc/net/nr
302
303 /sbin/swapoff /proc/swaps
304
305 /sbin/swapon /proc/swaps
306
307 /sbin/uugetty /proc/version
308
309 /usr/bin/dig /proc/
310 /usr/bin/dig /proc/interrupts
311 /usr/bin/dig /proc/meminfo
312 /usr/bin/dig /proc/rtc
313 /usr/bin/dig /proc/self/status
314 /usr/bin/dig /proc/stat
315
316 /usr/bin/dnsquery /proc/
317 /usr/bin/dnsquery /proc/interrupts
318 /usr/bin/dnsquery /proc/meminfo
319 /usr/bin/dnsquery /proc/rtc
320 /usr/bin/dnsquery /proc/self/status
321 /usr/bin/dnsquery /proc/stat
322
323 /usr/bin/eject /proc/mounts
324
325 /usr/bin/emacs /proc/loadavg
326
327 /usr/bin/fetchmail /proc/net/dev
328
329 /usr/bin/free /proc/meminfo
330
331 /usr/bin/gmake /proc/loadavg
332
333 /usr/bin/gpm-root /proc/loadavg
334 /usr/bin/gpm-root /proc/meminfo
335
336 /usr/bin/host /proc/
337 /usr/bin/host /proc/interrupts
338 /usr/bin/host /proc/meminfo
339 /usr/bin/host /proc/rtc
340 /usr/bin/host /proc/self/status
341 /usr/bin/host /proc/stat
342
343 /usr/bin/hoststat /proc/loadavg
344
345 /usr/bin/hwdiag /proc/cpuinfo
346 /usr/bin/hwdiag /proc/pci
347 /usr/bin/hwdiag /proc/scsi/scsi
348 /usr/bin/hwdiag /proc/version
349
350 /usr/bin/lsdev /proc/dma
351 /usr/bin/lsdev /proc/interrupts
352 /usr/bin/lsdev /proc/ioports
353
354 /usr/bin/mailq /proc/loadavg
355
356 /usr/bin/make /proc/loadavg
357
358 /usr/bin/mcookie /proc/loadavg
359 /usr/bin/mcookie /proc/stat
360
361 /usr/bin/newaliases /proc/loadavg
362
363 /usr/bin/nslookup /proc/
364 /usr/bin/nslookup /proc/interrupts
365 /usr/bin/nslookup /proc/meminfo
366 /usr/bin/nslookup /proc/rtc
367 /usr/bin/nslookup /proc/self/status
368 /usr/bin/nslookup /proc/stat
369
370 /usr/bin/nsupdate /proc/
371 /usr/bin/nsupdate /proc/interrupts
372 /usr/bin/nsupdate /proc/meminfo
373 /usr/bin/nsupdate /proc/rtc
374 /usr/bin/nsupdate /proc/self/status
375 /usr/bin/nsupdate /proc/stat
376
377 /usr/bin/pgp /proc/version
378 /usr/bin/pgpe /proc/version
379 /usr/bin/pgpk /proc/version
380 /usr/bin/pgps /proc/version
381 /usr/bin/pgpv /proc/version
382
383 /usr/bin/procinfo /proc/cmdline
384 /usr/bin/procinfo /proc/devices
385 /usr/bin/procinfo /proc/dma
386 /usr/bin/procinfo /proc/filesystems
387 /usr/bin/procinfo /proc/interrupts
388 /usr/bin/procinfo /proc/loadavg
389 /usr/bin/procinfo /proc/meminfo
390 /usr/bin/procinfo /proc/modules
391 /usr/bin/procinfo /proc/stat
392 /usr/bin/procinfo /proc/uptime
393 /usr/bin/procinfo /proc/version
394
395 /usr/bin/purgestat /proc/loadavg
396
397 /usr/bin/screen /proc/loadavg
398
399 /usr/bin/strace /proc/%d/stat
400
401 /usr/bin/top /proc/cpuinfo
402 /usr/bin/top /proc/meminfo
403 /usr/bin/top /proc/stat
404
405 /usr/bin/vmstat /proc/%s/stat
406 /usr/bin/vmstat /proc/meminfo
407 /usr/bin/vmstat /proc/stat
408
409 /usr/sbin/atd /proc/loadavg
410
411 /usr/sbin/dnskeygen /proc/
412 /usr/sbin/dnskeygen /proc/interrupts
413 /usr/sbin/dnskeygen /proc/meminfo
414 /usr/sbin/dnskeygen /proc/rtc
415 /usr/sbin/dnskeygen /proc/self/status
416 /usr/sbin/dnskeygen /proc/stat
417
418 /usr/sbin/fuser /proc/%d/stat
419 /usr/sbin/fuser /proc/net/%s
420 /usr/sbin/fuser /proc/net/unix
421
422 /usr/sbin/in.identd /proc/net/tcp
423
424 /usr/sbin/irpd /proc/
425 /usr/sbin/irpd /proc/interrupts
426 /usr/sbin/irpd /proc/meminfo
427 /usr/sbin/irpd /proc/rtc
428 /usr/sbin/irpd /proc/self/status
429 /usr/sbin/irpd /proc/stat
430
431 /usr/sbin/named /proc/
432 /usr/sbin/named /proc/interrupts
433 /usr/sbin/named /proc/meminfo
434 /usr/sbin/named /proc/rtc
435 /usr/sbin/named /proc/self/status
436 /usr/sbin/named /proc/stat
437
438 /usr/sbin/named-xfer /proc/
439 /usr/sbin/named-xfer /proc/interrupts
440 /usr/sbin/named-xfer /proc/meminfo
441 /usr/sbin/named-xfer /proc/rtc
442 /usr/sbin/named-xfer /proc/self/status
443 /usr/sbin/named-xfer /proc/stat
444
445 /usr/sbin/readprofile /proc/profile
446
447 /usr/sbin/rwhod /proc/loadavg
448 /usr/sbin/rwhod /proc/uptime
449
450 /usr/sbin/sendmail /proc/loadavg
451
452 /usr/sbin/setconsole /proc/openprom/options
453 /usr/sbin/setconsole /proc/openprom/options/${console}-mode
454 /usr/sbin/setconsole /proc/openprom/options/input-device
455 /usr/sbin/setconsole /proc/openprom/options/output-device
456
457 Best wishes from Riley.
458
459  * Copyright (C) 1999, Memory Alpha Systems.
460  * All rights and wrongs reserved.
461
462 +----------------------------------------------------------------------+
463 | There is something frustrating about the quality and speed of Linux  |
464 | development, ie., the quality is too high and the speed is too high, |
465 | in other words, I can implement this XXXX feature, but I bet someone |
466 | else has already done so and is just about to release their patch.   |
467 +----------------------------------------------------------------------+
468  * http://www.memalpha.cx/Linux/Kernel/
469
470
471 -
472 To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
473 the body of a message to majordomo@vger.rutgers.edu
474 Please read the FAQ at http://www.tux.org/lkml/
475