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