summaryrefslogtreecommitdiff
path: root/docs/new-applet-HOWTO.txt
diff options
context:
space:
mode:
authorGlenn L McGrath <bug1@ihug.co.nz>2001-06-24 12:36:54 +0000
committerGlenn L McGrath <bug1@ihug.co.nz>2001-06-24 12:36:54 +0000
commit2e6d3cfa82eb64fffe53ccb5669aa7146228cf8f (patch)
tree78fb21d71f9d8680422f85a00bc3045cd6185a99 /docs/new-applet-HOWTO.txt
parent15576268971168108f289cac6d6ecc6fdbb5075e (diff)
downloadbusybox-w32-2e6d3cfa82eb64fffe53ccb5669aa7146228cf8f.tar.gz
busybox-w32-2e6d3cfa82eb64fffe53ccb5669aa7146228cf8f.tar.bz2
busybox-w32-2e6d3cfa82eb64fffe53ccb5669aa7146228cf8f.zip
Nore unarchive (and doc) fixes from Laurence Anderson
Diffstat (limited to 'docs/new-applet-HOWTO.txt')
-rw-r--r--docs/new-applet-HOWTO.txt35
1 files changed, 15 insertions, 20 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt
index 90e124d01..1f5c3ebd5 100644
--- a/docs/new-applet-HOWTO.txt
+++ b/docs/new-applet-HOWTO.txt
@@ -70,40 +70,35 @@ you _write_ your applet) please read through the style guide in the docs
70directory and make your program compliant. 70directory and make your program compliant.
71 71
72 72
73Some Words on utility.c 73Some Words on libbb
74----------------------- 74-------------------
75 75
76As you are writing your applet, please be aware of the body of pre-existing 76As you are writing your applet, please be aware of the body of pre-existing
77useful functions in utility.c. Use these instead of reinventing the wheel. 77useful functions in libbb. Use these instead of reinventing the wheel.
78
79If you use functions from utility.c, you may need to add to the preprocessor
80conditionals in that file, to make sure the routines you need are included.
81So, since your mu implementation used safe_read(), append "|| defined BB_MU" to
82the #if instruction that precedes the safe_read() function in utility.c .
83 78
84Additionally, if you have any useful, general-purpose functions in your 79Additionally, if you have any useful, general-purpose functions in your
85program that could be useful in another program, consider putting them in 80program that could be useful in another program, consider putting them in
86utility.c. 81libbb.
87 82
88 83
89Usage String(s) 84Usage String(s)
90--------------- 85---------------
91 86
92Next, add usage information for you applet to usage.c. This should look like 87Next, add usage information for you applet to usage.h. This should look like
93the following: 88the following:
94 89
95 #if defined BB_MU 90 #define mu_trivial_usage \
96 const char mu_usage[] = 91 "-[abcde] FILES"
97 "mu\n" 92 #define mu_full_usage \
98 #ifndef BB_FEATURE_TRIVIAL_HELP 93 "Returns an indeterminate value.\n\n" \
99 "\nReturns an indeterminate value.\n" 94 "Options:\n" \
100 #endif 95 "\t-a\t\tfirst function\n" \
101 ; 96 "\t-b\t\tsecond function\n" \
102 97
103If your program supports flags, the flags should be mentioned on the first 98If your program supports flags, the flags should be mentioned on the first
104line (mu -[bcRovma]) and a detailed description of each flag should go in the 99line (-[abcde]) and a detailed description of each flag should go in the
105BB_FEATURE_TRIVIAL_HELP section, one flag per line. (Numerous examples of this 100mu_full_usage section, one flag per line. (Numerous examples of this
106currently exist in usage.c.) 101currently exist in usage.h.)
107 102
108 103
109Header Files 104Header Files