aboutsummaryrefslogtreecommitdiff
path: root/www/code.html
diff options
context:
space:
mode:
authorRob Landley <rob@landley.net>2016-03-23 03:25:37 -0500
committerRob Landley <rob@landley.net>2016-03-23 03:25:37 -0500
commita8d0d13376251e1ff35a557dddea1d2e3c81a149 (patch)
tree91ac62baa71572bbd900222ad99338778557e167 /www/code.html
parentc23186d3ee6001b78c843fc3609575306c687ba2 (diff)
downloadtoybox-a8d0d13376251e1ff35a557dddea1d2e3c81a149.tar.gz
Redo build stuff in response to Andy Chu's suggestions.
Toybox single binaries are now made directly with the new name instead of stomping toybox and getting renamed. Unstripped files now live in generated/unstripped. Target to run all tests is now "make tests" to avoid conflict with "make test". .singleconfig now has .PHONY: entries for all test_$NAME targets. Default install location changed to /usr/toybox, code.html now says how to change it (set $PREFIX). scripts/install.sh --uninstall works now. (And you get to keep the pieces!)
Diffstat (limited to 'www/code.html')
-rw-r--r--www/code.html20
1 files changed, 16 insertions, 4 deletions
diff --git a/www/code.html b/www/code.html
index c133611c..c0566b4c 100644
--- a/www/code.html
+++ b/www/code.html
@@ -55,6 +55,13 @@ to the environment will take precedence.</p>
I.E. "what to build", and "configure" describes the build and installation
environment, I.E. "how to build it".)</p>
+<p>By default "make install" puts files in /usr/toybox. Adding this to the
+$PATH is up to you. The environment variable $PREFIX can change the
+install location, ala "PREFIX=/usr/local/bin make install".</p>
+
+<p>If you need an unstripped (debug) version of any of these binaries,
+look in generated/unstripped.</p>
+
<p><h1><a name="running"><a href="#running">Running a command</a></h1></p>
<h2>main</h2>
@@ -444,10 +451,15 @@ as specified by the options field off this command's toy_list entry. See
the get_optargs() description in lib/args.c for details.</p>
</li>
-<li><b>char toybuf[4096]</b> - a common scratch space buffer so
-commands don't need to allocate their own. Any command is free to use this,
-and it should never be directly referenced by functions in lib/ (although
-commands are free to pass toybuf in to a library function as an argument).</li>
+<li><b>char toybuf[4096]</b> - a common scratch space buffer guaranteed
+to start zeroed, so commands don't need to allocate/initialize their own.
+Any command is free to use this, and it should never be directly referenced
+by functions in lib/ (although commands are free to pass toybuf in to a
+library function as an argument).</li>
+
+<li><b>char libbuf[4096]</b> - like toybuf, but for use by common code in
+lib/*.c. Commands should never directly reference libbuf, and library
+could should nnever directly reference toybuf.</li>
</ul>
<p>The following functions are defined in main.c:</p>