[BusyBox] documentation patch and what's missing.

[Terje Kvernes]

Erik Andersen <andersen at codepoet.org> writes:

> On Mon Jul 21, 2003 at 01:00:08AM +0200, Terje Kvernes wrote:
>  
> > right.  this covers most of whats missing in the help texts.  the
> > stuff that is left are the following tidbits that I was unable to
> > understand well enough to dare to document.
> 
> Thanks!!!  Applied.

  okay, I've gone through miscutils and fixed the missing
  documentation there, and I _think_ I understand what
  CONFIG_ASH_CMDCMD does.  hopefully someone will verify that bit,
  it's the last part of the patch.

  now, only two options are yet to be documented:

  from modutils/Config.in

    * CONFIG_FEATURE_INSMOD_LOADINKMEM

      this only works under uClinux and only with regards to module
      loading.  from reading the code we do indeed seem to be stuffing
      a module directly into kernel memory, but I'm rather unsure as
      the implications this has for insmod.

  from networking/Config.in

    * CONFIG_FEATURE_TRACEROUTE_SO_DEBUG

      this basically just sets the SO_DEBUG flag on the socket.  as
      far as I can tell, this just makes the kernel a bit noisy when
      you're using traceroute.  is there any other documentation one
      should add?


diff -ur busybox/miscutils/Config.in busybox-patched/miscutils/Config.in
--- busybox/miscutils/Config.in 2003-07-14 21:36:58.000000000 +0200
+++ busybox-patched/miscutils/Config.in 2003-07-22 21:43:15.103579262 +0200
@@ -37,13 +37,15 @@
        bool "dutmp"
        default n
        help
-         Please submit a patch to add help text for this item.
+         Dump colon seperated utmp information to STDOUT.  IP addresses
+         are given in hex, little endian on x86.
 
 config CONFIG_MAKEDEVS
        bool "makedevs"
        default n
        help
-         Please submit a patch to add help text for this item.
+         The "makedevs" applet lets you easily create ranges of
+          device nodes.
 
 config CONFIG_MT
        bool "mt"
@@ -72,13 +74,14 @@
        bool "update"
        default n
        help
-         Please submit a patch to add help text for this item.
+         Flush filesystem buffers with linux kernels 2.0 and older.
 
 config CONFIG_WATCHDOG
        bool "watchdog"
        default n
        help
-         Please submit a patch to add help text for this item.
+         A simple applet that will write '\0' to its first argument
+          every 30 seconds, returning only when writing failes.
 
 endmenu
 
diff -ur busybox/shell/Config.in busybox-patched/shell/Config.in
--- busybox/shell/Config.in     2003-07-21 00:10:33.000000000 +0200
+++ busybox-patched/shell/Config.in     2003-07-22 21:48:05.970923045 +0200
@@ -80,7 +80,9 @@
        default n
        depends on CONFIG_ASH
        help
-         Please submit a patch to add help text for this item.
+         By enabling this feature, you can use "cmd cmd args" to
+          avoid ash calling the builtin "cmd", thereby making sure
+          that "cmd" is gotten from $PATH.
 
 config CONFIG_ASH_MAIL
        bool "  Check for new mail on interactive shells"

-- 
Terje