aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEric Andersen <andersen@codepoet.org>2001-10-24 05:00:29 +0000
committerEric Andersen <andersen@codepoet.org>2001-10-24 05:00:29 +0000
commitbdfd0d78bc44e73d693510e70087857785b3b521 (patch)
tree153a573095afac8d8d0ea857759ecabd77fb28b7 /docs
parent9260fc5552a3ee52eb95823aa6689d52a1ffd33c (diff)
downloadbusybox-w32-bdfd0d78bc44e73d693510e70087857785b3b521.tar.gz
busybox-w32-bdfd0d78bc44e73d693510e70087857785b3b521.tar.bz2
busybox-w32-bdfd0d78bc44e73d693510e70087857785b3b521.zip
Major rework of the directory structure and the entire build system.
-Erik
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/autodocifier.pl4
-rw-r--r--docs/busybox.net/index.html3
-rw-r--r--docs/busybox.net/oldnews.html23
-rw-r--r--docs/new-applet-HOWTO.txt4
-rw-r--r--docs/style-guide.txt10
5 files changed, 20 insertions, 24 deletions
diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl
index d753300c1..3016e4022 100755
--- a/docs/autodocifier.pl
+++ b/docs/autodocifier.pl
@@ -251,7 +251,7 @@ a command. I<REQUIRED>
251=item B<full> 251=item B<full>
252 252
253This should contain descriptions of each option. This will also 253This should contain descriptions of each option. This will also
254be displayed along with the trivial help if BB_FEATURE_TRIVIAL_HELP 254be displayed along with the trivial help if CONFIG_FEATURE_TRIVIAL_HELP
255is disabled. I<REQUIRED> 255is disabled. I<REQUIRED>
256 256
257=item B<notes> 257=item B<notes>
@@ -284,4 +284,4 @@ John BEPPU <beppu@lineo.com>
284 284
285=cut 285=cut
286 286
287# $Id: autodocifier.pl,v 1.21 2001/04/17 17:09:34 beppu Exp $ 287# $Id: autodocifier.pl,v 1.22 2001/10/24 04:59:20 andersen Exp $
diff --git a/docs/busybox.net/index.html b/docs/busybox.net/index.html
index b396b4b16..a0b4e6ccf 100644
--- a/docs/busybox.net/index.html
+++ b/docs/busybox.net/index.html
@@ -295,7 +295,6 @@ listed in the order I happen to add them to the web page:
295 295
296<ul> 296<ul>
297 <li> <a href="http://cvs.debian.org/boot-floppies/">Debian installer (boot floppies) project</a> 297 <li> <a href="http://cvs.debian.org/boot-floppies/">Debian installer (boot floppies) project</a>
298 <li> <a href="ftp://ftp.slackware.com/pub/slackware/slackware-8.0/source/rootdsks/">Slackware 8.0 installer</a>
299 <li> <a href="http://www.linuxrouter.org/">Linux Router Project </a> 298 <li> <a href="http://www.linuxrouter.org/">Linux Router Project </a>
300 <li> <a href="http://linux-embedded.org/">LEM</a> 299 <li> <a href="http://linux-embedded.org/">LEM</a>
301 <li> <a href="http://www.toms.net/rb/">tomsrtbt</a> 300 <li> <a href="http://www.toms.net/rb/">tomsrtbt</a>
@@ -325,7 +324,7 @@ listed in the order I happen to add them to the web page:
325 <li> <a href="http://dutnux.sourceforge.net/">DutNux</a> 324 <li> <a href="http://dutnux.sourceforge.net/">DutNux</a>
326 <li> <a href="http://www.cachier.com/">Cachier</a> 325 <li> <a href="http://www.cachier.com/">Cachier</a>
327 <li> <a href="http://www.microwerks.net/~hugo/mindi/">Mindi</a> 326 <li> <a href="http://www.microwerks.net/~hugo/mindi/">Mindi</a>
328 <li> <a href="http://www.tzi.de/~pharao90/ttylinux/">ttylinux</a> 327
329</ul> 328</ul>
330 329
331<p> Do you use BusyBox? I'd love to know about it and I'd be happy to link to 330<p> Do you use BusyBox? I'd love to know about it and I'd be happy to link to
diff --git a/docs/busybox.net/oldnews.html b/docs/busybox.net/oldnews.html
index d97bb2684..08a49caf8 100644
--- a/docs/busybox.net/oldnews.html
+++ b/docs/busybox.net/oldnews.html
@@ -74,12 +74,12 @@
74 <li> <b>Busybox Boot-Floppy Image</b> 74 <li> <b>Busybox Boot-Floppy Image</b>
75 75
76 <p>Because you asked for it, we have made available a <a href= 76 <p>Because you asked for it, we have made available a <a href=
77 "ftp://opensource.lineo.com/busybox/busybox.floppy.img"> Busybox boot floppy 77 "ftp://oss.lineo.com/busybox/busybox.floppy.img"> Busybox boot floppy
78 image</a>. Here's how you use it: 78 image</a>. Here's how you use it:
79 79
80 <ol> 80 <ol>
81 81
82 <li> <a href= "ftp://opensource.lineo.com/busybox/busybox.floppy.img"> 82 <li> <a href= "ftp://oss.lineo.com/busybox/busybox.floppy.img">
83 Download the image</a> 83 Download the image</a>
84 84
85 <li> dd it onto a floppy like so: <tt> dd if=busybox.floppy.img 85 <li> dd it onto a floppy like so: <tt> dd if=busybox.floppy.img
@@ -203,13 +203,13 @@
203 details). 203 details).
204 <p> 204 <p>
205 Also, some exciting infrastructure news! Busybox now has its own 205 Also, some exciting infrastructure news! Busybox now has its own
206 <a href="http://opensource.lineo.com/lists/busybox/">mailing list</a>, 206 <a href="http://oss.lineo.com/lists/busybox/">mailing list</a>,
207 publically browsable 207 publically browsable
208 <a href="http://opensource.lineo.com/cgi-bin/cvsweb/busybox/">CVS tree</a>, 208 <a href="http://oss.lineo.com/cgi-bin/cvsweb/busybox/">CVS tree</a>,
209 anonymous 209 anonymous
210 <a href="http://opensource.lineo.com/cvs_anon.html">CVS access</a>, and 210 <a href="http://oss.lineo.com/cvs_anon.html">CVS access</a>, and
211 for those that are actively contributing there is even 211 for those that are actively contributing there is even
212 <a href="http://opensource.lineo.com/cvs_write.html">CVS write access</a>. 212 <a href="http://oss.lineo.com/cvs_write.html">CVS write access</a>.
213 I think this will be a huge help to the ongoing development of BusyBox. 213 I think this will be a huge help to the ongoing development of BusyBox.
214 <p> 214 <p>
215 Also, for the curious, there is no 0.44 release. Somehow 0.44 got announced 215 Also, for the curious, there is no 0.44 release. Somehow 0.44 got announced
@@ -398,13 +398,10 @@
398 Freshmeat AppIndex record for BusyBox</A> 398 Freshmeat AppIndex record for BusyBox</A>
399 <p> 399 <p>
400 400
401 <li> <a href="http://opensource.lineo.com/software.html">Other cool embedded software</a>. 401 <li> <a href="http://oss.lineo.com/software.html">Cool embedded software</a>.
402 <p> 402 <p>
403 403
404 <li> <a href="http://opensource.lineo.com/">opensource.lineo.com</a>. 404 <li> <a href="http://oss.lineo.com/">oss.lineo.com</a>.
405 <p>
406
407 <li> <A HREF="http://www.lineo.com/">Lineo</A> is sponsoring BusyBox development.
408 <p> 405 <p>
409 406
410</ul> 407</ul>
@@ -425,8 +422,8 @@
425 <TD> 422 <TD>
426 <font size="-1" face="arial, helvetica, sans-serif"> 423 <font size="-1" face="arial, helvetica, sans-serif">
427 Mail all comments, insults, suggestions and bribes to 424 Mail all comments, insults, suggestions and bribes to
428 <a href="mailto:andersen@lineo.com">Erik Andersen</a><BR> 425 <a href="mailto:andersen@codepoet.org">Erik Andersen</a><BR>
429 The Busybox logo is copyright 1999,2000, Erik Andersen. 426 The Busybox logo is copyright 1999,2000,2001 Erik Andersen.
430 </font> 427 </font>
431 </TD> 428 </TD>
432 429
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt
index 1f5c3ebd5..a00dfcc30 100644
--- a/docs/new-applet-HOWTO.txt
+++ b/docs/new-applet-HOWTO.txt
@@ -109,7 +109,7 @@ order, or else it will break the binary-search lookup algorithm in busybox.c
109and the Gods of BusyBox smite you. Yea, verily: 109and the Gods of BusyBox smite you. Yea, verily:
110 110
111 /* all programs above here are alphabetically "less than" 'mu' */ 111 /* all programs above here are alphabetically "less than" 'mu' */
112 #ifdef BB_MU 112 #ifdef CONFIG_MU
113 APPLET("mu", mu_main, _BB_DIR_USR_BIN, mu_usage) 113 APPLET("mu", mu_main, _BB_DIR_USR_BIN, mu_usage)
114 #endif 114 #endif
115 /* all programs below here are alphabetically "greater than" 'mu' */ 115 /* all programs below here are alphabetically "greater than" 'mu' */
@@ -117,7 +117,7 @@ and the Gods of BusyBox smite you. Yea, verily:
117 117
118Finally, add a define for your applet to Config.h: 118Finally, add a define for your applet to Config.h:
119 119
120 #define BB_MU 120 #define CONFIG_MU
121 121
122 122
123Documentation 123Documentation
diff --git a/docs/style-guide.txt b/docs/style-guide.txt
index c71f1e609..25c676ca2 100644
--- a/docs/style-guide.txt
+++ b/docs/style-guide.txt
@@ -252,7 +252,7 @@ files, you can do the following in the busybox directory:
252If you want to convert all the non-K&R vars in your file all at once, follow 252If you want to convert all the non-K&R vars in your file all at once, follow
253these steps: 253these steps:
254 254
255 - In the busybox directory type 'scripts/mk2knr.pl files-to-convert'. This 255 - In the busybox directory type 'examples/mk2knr.pl files-to-convert'. This
256 does not do the actual conversion, rather, it generates a script called 256 does not do the actual conversion, rather, it generates a script called
257 'convertme.pl' that shows what will be converted, giving you a chance to 257 'convertme.pl' that shows what will be converted, giving you a chance to
258 review the changes beforehand. 258 review the changes beforehand.
@@ -269,7 +269,7 @@ these steps:
269 269
270Please be aware of changes that have cascading effects into other files. For 270Please be aware of changes that have cascading effects into other files. For
271example, if you're changing the name of something in, say utility.c, you 271example, if you're changing the name of something in, say utility.c, you
272should probably run 'scripts/mk2knr.pl utility.c' at first, but when you run 272should probably run 'examples/mk2knr.pl utility.c' at first, but when you run
273the 'convertme.pl' script you should run it on _all_ files like so: 273the 'convertme.pl' script you should run it on _all_ files like so:
274'./convertme.pl *.[ch]'. 274'./convertme.pl *.[ch]'.
275 275
@@ -343,7 +343,7 @@ used in the code.
343 ret = my_func(bar, baz); 343 ret = my_func(bar, baz);
344 if (!ret) 344 if (!ret)
345 return -1; 345 return -1;
346 #ifdef BB_FEATURE_FUNKY 346 #ifdef CONFIG_FEATURE_FUNKY
347 maybe_do_funky_stuff(bar, baz); 347 maybe_do_funky_stuff(bar, baz);
348 #endif 348 #endif
349 349
@@ -351,7 +351,7 @@ used in the code.
351 351
352 (in .h header file) 352 (in .h header file)
353 353
354 #ifdef BB_FEATURE_FUNKY 354 #ifdef CONFIG_FEATURE_FUNKY
355 static inline void maybe_do_funky_stuff (int bar, int baz) 355 static inline void maybe_do_funky_stuff (int bar, int baz)
356 { 356 {
357 /* lotsa code in here */ 357 /* lotsa code in here */
@@ -487,7 +487,7 @@ very limited stack space (e.g., uCLinux).
487A macro is declared in busybox.h that implements compile-time selection 487A macro is declared in busybox.h that implements compile-time selection
488between xmalloc() and stack creation, so you can code the line in question as 488between xmalloc() and stack creation, so you can code the line in question as
489 489
490 RESERVE_BB_BUFFER(buffer, BUFSIZ); 490 RESERVE_CONFIG_BUFFER(buffer, BUFSIZ);
491 491
492and the right thing will happen, based on your configuration. 492and the right thing will happen, based on your configuration.
493 493