diff options
author | Rob Landley <rob@landley.net> | 2022-03-26 13:32:57 -0500 |
---|---|---|
committer | Rob Landley <rob@landley.net> | 2022-03-26 13:32:57 -0500 |
commit | a59792c73caefa7c81c9d1b22b20c60dd3e34926 (patch) | |
tree | f2b9f7710a3bed4723ca4ea63d6da9c15c13cc12 | |
parent | 5f3655239420471774faaa1cb648056a3406340f (diff) | |
download | toybox-a59792c73caefa7c81c9d1b22b20c60dd3e34926.tar.gz |
Update docs.
-rw-r--r-- | toys/example/README | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/toys/example/README b/toys/example/README index 0ebc2028..6e73fa18 100644 --- a/toys/example/README +++ b/toys/example/README @@ -2,13 +2,22 @@ Example commands You probably don't want to deploy any of this. -The hello.c and skeleton.c commands provide templates for new commands: -hello.c is clean and simple, skeleton.c demonstrates the option parsing -infrastructure and having multiple commands per file. When writing a new -command, copying hello.c or skeleton.c to the new name may provide a good -starting point. (The minimal staring point is toys/posix/false.c) +The hello.c and skeleton.c commands provide templates for new commands. When +writing a new command, copying hello.c or skeleton.c to the new name may provide +a good starting point. (The minimal staring point is toys/posix/false.c) -The demo_* commands demonstrate infrastructure, and do regression testing. + - hello.c is clean and simple, and an easy way to check the behavior of + toybox library functions running in command context. -Other commands in here are obsolete versions still in some recent Linux systems -(and often still in posix), but not really useful on modern systems. + - skeleton.c demonstrates the option parsing infrastructure and having + multiple commands per file. + +Some of the commands in here are test infrastructure: + + - logpath.c is optionally used by mkroot.sh and scripts/record-commands + + - demo_* demonstrates infrastructure, allowing tests/demo_*.test to + regression test library functions directly. + +hostid.c is an obsolete command still in posix and present on some recent +Linux systems, but not really useful on modern systems. |