aboriginal: www/documentation.html comparison

comparison www/documentation.html @ 520:16adbffb58b0

More documentation tweaks, adding a new target section.

author	Rob Landley <rob@landley.net>
date	Tue, 02 Dec 2008 04:49:10 -0600
parents	f109c324cca4
children	ad14395e1f0c

comparison

equal deleted inserted replaced

-:1c36145a54d1
+:16adbffb58b0
 <li><a href="#what_is_it">What is Firmware Linux?</a></li>
 <li><a href="#how_system_image">How do I use system images?</a></li>
 <li><a href="#how_build_source">How do I build my own customized system images from source code?</a></li>
 <li><a href="#how_implemented">How is Firmware Linux implemented?</a></li>
 <li><a href="#why">Why do things this way?</a></li>
+<li><a href="#new_platform">Adding a new target platform</a></li>
 </ul>
 <hr />
 <a name="what_is_it"><h1>What is Firmware Linux?</h1></a>
 <p>To use this emulated system as a native build environment, see
 <a href="#native_compiling">native compiling</a>.</p>
-<a name="new_platform"><h1>Setting up a new platform</h1></a>
+<a name="new_platform"><h1>Adding a new target platform</h1></a>
 <p>The differences between platforms are confined to a single directory,
 sources/targets.  Each subdirectory under that contains all the configuration
 information for a specific target platform FWL can produce system images
 for.  The same scripts build the same packages for each platform, differing
 <li><p><b>emulator_command</b> - Shell function run to generate the actual
 emulator invocation at the end of the run-$ARCH.sh shell script in the system
 image tarball.</p>
-<p>This is actually a shell function, not an environment variable.  The
+<p>This is actually a shell function, not an environment variable.  It's
-function should output an emulator command line to stdout (generally
+called from package-mini-native.sh to output an emulator command line to
-using "echo").  The function receives three arguments: $1 is the name of the
+stdout (generally using "echo").<p>
-ext2 image containing the root filesystem, $2 is the name of the kernel image,
-$3 is a set of
+<p>The function receives two arguments: $1 is the name of the ext2 image
-platform-independent kernel command line arguments (currently "rw
+containing the root filesystem, and $2 is the name of the kernel image.
-init=/tools/bin/sh panic=1 PATH=/tools/bin") to which emulator_command should
+The function can also call another shell function, <b>qemu_defaults</b>,
-append at least root= and console= arguments.</p>
+which is defined in package-mini-native.sh and which provides most of
+the qemu command line.  (If you use a different emulator, you don't have to
-This function is called from
+call this function, but if you use qemu it makes things a lot easier and
-include.sh.</p>
+more consistent.)  The qemu_command function outputs $ROOT and $CONSOLE
+variables for its root= and console= kernel command line arguments, so
+set those before calling it.</p>
-</ul>
+</li>
-<p>The <b>details</b> file also defines the shell function
+</ul>
-<b>emulator_command</b>, which is run to generate the actual emulator
-invocation at the end of the run-$ARCH.sh shell script in the system image
+<a name="miniconfig"><h2>Miniconfig files</h2></a>
-tarball.  The function should
-output an emulator command line to stdout (generally using "echo").  The
+<p>The expanded .config files used to build both Linux and uClibc are copied
-function receives three arguments: $1 is the name of the ext2 image containing
+into the /usr/src directory of mini-native filesystems during the build,
-the root filesystem, $2 is the name of the kernel image, $3 is a set of
+and kept for future reference.</p>
-platform-independent kernel command line arguments (currently "rw
-init=/tools/bin/sh panic=1 PATH=/tools/bin") to which emulator_command should
+<p>The Linux kernel and uClibc each need a configuration file to build.
-append at least root= and console= arguments.</p>
+Firmware Linux uses the "miniconfig" file format, which contains only the configuration
-This function is called from
-include.sh.</p>
-<a name="miniconfig"><h2>miniconfig-linux</h2>
-<p>The Linux kernel needs a configuration file to build.  Firmware Linux
-uses the "miniconfig" file format, which contains only the configuration
 symbols a user would have to switch on in menuconfig if they started from
 allnoconfig.</p>
-<p>This file is written as a "here" document, ala:</p>
-<blockquote>
-<pre>
-cat > "${WORK}"/miniconfig-linux << 'EOF'
-[insert file contents here]
-EOF
-</pre>
-</blockquote>
 <p>To generate a miniconfig, first configure your kernel with menuconfig,
 then copy the resulting .config file to a temporary filename (such as
 "tempfile").  Then run the miniconfig.sh script in the sources/toys directory
 with the temporary file name as your argument and with the environment variable
 </pre>
 </blockquote>
 <p>Remember to supply an actual value for $KARCH.</p>
-<h2>miniconfig-uClibc</h2>
+<h2>$ARCH/miniconfig-linux</h2>
+<p>This is the miniconfig file to build a Linux kernel for the appropriate
+target.  This is usually aimed at booting under QEMU, but if you'd like
+to come up with your own configuration for actual target hardware, feel
+free.</p>
+<h2>$ARCH/miniconfig-uClibc</h2>
 <p>Just like the Linux kernel, uClibc needs a .config file to build, and
 so the Firmware Linux configuration file supplies a miniconfig.  Note that
 uClibc doesn't require an ARCH= value, because all its architecture information
 is stored in the config file.  Otherwise the procedure for creating and using
 it is the same as for the Linux kernel, just with a different filename and
 contents.</p>
-<p>Note that Firmware Linux patches uClibc to work with miniconfig files,
+<p>Most of each miniconfig-uClibc is identical from platform to platform.
-the base uClibc 0.9.29 release doesn't support miniconfig files yet.</p>
+At some point in the future this boilerplate might be factored out into
+a common file, but so far removing the duplication hasn't been worth the
+extra complexity.</p>
 <hr>
 <!--

Mercurial > hg > aboriginal

comparison www/documentation.html @ 520:16adbffb58b0