aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Landley <rob@landley.net>2008-01-19 17:49:51 -0600
committerRob Landley <rob@landley.net>2008-01-19 17:49:51 -0600
commit2d471cebb6dd4c4eb13f4926733fe2a04e53907a (patch)
treef4dd450b98d5a89fd6ebd8628b3fe4eddeaf64ae
parent55928b1e0a08d84a5cbc50020f0a8c1024f5b6ce (diff)
downloadtoybox-2d471cebb6dd4c4eb13f4926733fe2a04e53907a.tar.gz
More documentation for generated/* files.
-rw-r--r--generated/README.txt18
1 files changed, 16 insertions, 2 deletions
diff --git a/generated/README.txt b/generated/README.txt
index e7b0325f..93a10398 100644
--- a/generated/README.txt
+++ b/generated/README.txt
@@ -1,3 +1,17 @@
All the files in this directory except this README are generated by the
-build. Some of them may require python on the host system, and are thus
-shipped in the build tarball so python isn't a build requirement.
+build. (See scripts/make.sh)
+
+config.h: CFG_COMMAND and USE_COMMAND() macros set by menuconfig via .config.
+
+Config.in: Kconfig entries for each command. Included by top level Config.in.
+ The help text in here is used to generated help.h
+
+help.h: Help text strings for use by "help" command. Building this file
+ requires python on the host system, so the prebuilt file is shipped
+ in the build tarball to avoid requiring python to build toybox.
+
+newtoys.h: List of NEWTOY() or OLDTOY() macros for all available commands.
+ Associates command_main() functions with command names, provides
+ option string for command line parsing (see lib/args.c), specifies
+ where to install each command and whether toysh should fork before
+ calling it.