diff options
author | Robert P. J. Day <rpjday@crashcourse.ca> | 2013-11-25 10:53:48 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:54:10 +0000 |
commit | c2db7f4cb973c5f1ae80f76e84077918ca4606ee (patch) | |
tree | cdb07de71488c16a6ff9a747d8c95e19defd66db /documentation | |
parent | cd64633f9407dc706563290cba235243be344970 (diff) | |
download | poky-c2db7f4cb973c5f1ae80f76e84077918ca4606ee.tar.gz |
dev-manual: Documentation: More minor tweaks to dev manual for clarity
i'm still looking at the dev manual for more changes but those would
be more substantive changes, so i'll pass along just this collection
of minor stuff.
(From yocto-docs rev: 3ea3fd4625c571f8cf20e32e6edc03ba1e517e94)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index e7bebefb63..4223bb118b 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -2868,7 +2868,7 @@ the details. | |||
2868 | <filename>.config</filename> file.</para></listitem> | 2868 | <filename>.config</filename> file.</para></listitem> |
2869 | <listitem><para>Configuration items that appear twice in the same | 2869 | <listitem><para>Configuration items that appear twice in the same |
2870 | configuration fragment.</para></listitem> | 2870 | configuration fragment.</para></listitem> |
2871 | <listitem><para>Configuration items tagged as "required" were overridden. | 2871 | <listitem><para>Configuration items tagged as "required" that were overridden. |
2872 | </para></listitem> | 2872 | </para></listitem> |
2873 | <listitem><para>A board overrides a non-board specific option.</para></listitem> | 2873 | <listitem><para>A board overrides a non-board specific option.</para></listitem> |
2874 | <listitem><para>Listed options not valid for the kernel being processed. | 2874 | <listitem><para>Listed options not valid for the kernel being processed. |
@@ -2972,8 +2972,8 @@ the details. | |||
2972 | <para> | 2972 | <para> |
2973 | The first step is to create a layer so you can isolate your changes: | 2973 | The first step is to create a layer so you can isolate your changes: |
2974 | <literallayout class='monospaced'> | 2974 | <literallayout class='monospaced'> |
2975 | $cd ~/poky | 2975 | $ cd ~/poky |
2976 | $mkdir meta-mylayer | 2976 | $ mkdir meta-mylayer |
2977 | </literallayout> | 2977 | </literallayout> |
2978 | Creating a directory that follows the Yocto Project layer naming | 2978 | Creating a directory that follows the Yocto Project layer naming |
2979 | conventions sets up the layer for your changes. | 2979 | conventions sets up the layer for your changes. |
@@ -3040,7 +3040,7 @@ the details. | |||
3040 | Edit the <filename>init/calibrate.c</filename> file to have the | 3040 | Edit the <filename>init/calibrate.c</filename> file to have the |
3041 | following changes: | 3041 | following changes: |
3042 | <literallayout class='monospaced'> | 3042 | <literallayout class='monospaced'> |
3043 | void __cpuinit calibrate_delay(void) | 3043 | void calibrate_delay(void) |
3044 | { | 3044 | { |
3045 | unsigned long lpj; | 3045 | unsigned long lpj; |
3046 | static bool printed; | 3046 | static bool printed; |
@@ -3406,12 +3406,12 @@ the details. | |||
3406 | <para> | 3406 | <para> |
3407 | The following list presents the overall steps you need to | 3407 | The following list presents the overall steps you need to |
3408 | consider and perform to create distributions with smaller | 3408 | consider and perform to create distributions with smaller |
3409 | root filesystems, faster boot times, maintain your critical | 3409 | root filesystems, achieve faster boot times, maintain your critical |
3410 | functionality, and avoid initial RAM disks: | 3410 | functionality, and avoid initial RAM disks: |
3411 | <itemizedlist> | 3411 | <itemizedlist> |
3412 | <listitem><para>Determine your goals and guiding | 3412 | <listitem><para>Determine your goals and guiding |
3413 | principles.</para></listitem> | 3413 | principles.</para></listitem> |
3414 | <listitem><para>Understand what gives your image size. | 3414 | <listitem><para>Understand what contributes to your image size. |
3415 | </para></listitem> | 3415 | </para></listitem> |
3416 | <listitem><para>Reduce the size of the root filesystem. | 3416 | <listitem><para>Reduce the size of the root filesystem. |
3417 | </para></listitem> | 3417 | </para></listitem> |
@@ -3457,7 +3457,7 @@ the details. | |||
3457 | </section> | 3457 | </section> |
3458 | 3458 | ||
3459 | <section id='understand-what-gives-your-image-size'> | 3459 | <section id='understand-what-gives-your-image-size'> |
3460 | <title>Understand What Gives Your Image Size</title> | 3460 | <title>Understand What Contributes to Your Image Size</title> |
3461 | 3461 | ||
3462 | <para> | 3462 | <para> |
3463 | It is easiest to have something to start with when creating | 3463 | It is easiest to have something to start with when creating |
@@ -3485,7 +3485,7 @@ the details. | |||
3485 | Memory consists of static, dynamic, and temporary memory. | 3485 | Memory consists of static, dynamic, and temporary memory. |
3486 | Static memory is the TEXT (code), DATA (initialized data | 3486 | Static memory is the TEXT (code), DATA (initialized data |
3487 | in the code), and BSS (uninitialized data) sections. | 3487 | in the code), and BSS (uninitialized data) sections. |
3488 | Dynamic memory contains memory that is allocated at runtime, | 3488 | Dynamic memory represents memory that is allocated at runtime: |
3489 | stacks, hash tables, and so forth. | 3489 | stacks, hash tables, and so forth. |
3490 | Temporary memory is recovered after the boot process. | 3490 | Temporary memory is recovered after the boot process. |
3491 | This memory consists of memory used for decompressing | 3491 | This memory consists of memory used for decompressing |
@@ -3561,8 +3561,8 @@ the details. | |||
3561 | </literallayout> | 3561 | </literallayout> |
3562 | You can apply a filter to the script to ignore files under | 3562 | You can apply a filter to the script to ignore files under |
3563 | a certain size. | 3563 | a certain size. |
3564 | This example filters out anything below 100 Kbytes. | 3564 | The previous example filters out any files below 100 Kbytes. |
3565 | The sizes reported by the tool are uncompressed and thus, | 3565 | The sizes reported by the tool are uncompressed, and thus |
3566 | will be smaller by a relatively constant factor in a | 3566 | will be smaller by a relatively constant factor in a |
3567 | compressed root filesystem. | 3567 | compressed root filesystem. |
3568 | When you examine your log file, you can focus on areas of the | 3568 | When you examine your log file, you can focus on areas of the |
@@ -3592,7 +3592,7 @@ the details. | |||
3592 | </para> | 3592 | </para> |
3593 | 3593 | ||
3594 | <para> | 3594 | <para> |
3595 | Use the <filename>local.conf</filename> file to make changes. | 3595 | Use your <filename>local.conf</filename> file to make changes. |
3596 | For example, to eliminate <filename>udev</filename> and | 3596 | For example, to eliminate <filename>udev</filename> and |
3597 | <filename>glib</filename>, set the following in the | 3597 | <filename>glib</filename>, set the following in the |
3598 | local configuration file: | 3598 | local configuration file: |
@@ -3611,7 +3611,7 @@ the details. | |||
3611 | using <filename>initramfs</filename>. | 3611 | using <filename>initramfs</filename>. |
3612 | Be aware that <filename>ext3</filename> requires a 1 Mbyte | 3612 | Be aware that <filename>ext3</filename> requires a 1 Mbyte |
3613 | journal. | 3613 | journal. |
3614 | If you are okay with running read-only you do not need this | 3614 | If you are okay with running read-only, you do not need this |
3615 | journal. | 3615 | journal. |
3616 | </para> | 3616 | </para> |
3617 | 3617 | ||
@@ -3632,7 +3632,7 @@ the details. | |||
3632 | aspects. | 3632 | aspects. |
3633 | What subsystems do you enable? | 3633 | What subsystems do you enable? |
3634 | For what architecture are you building? | 3634 | For what architecture are you building? |
3635 | Which drivers do you build by default. | 3635 | Which drivers do you build by default? |
3636 | <note>You can modify the kernel source if you want to help | 3636 | <note>You can modify the kernel source if you want to help |
3637 | with boot time. | 3637 | with boot time. |
3638 | </note> | 3638 | </note> |
@@ -3651,7 +3651,7 @@ the details. | |||
3651 | taken up with the built-in <filename>.o</filename> files for | 3651 | taken up with the built-in <filename>.o</filename> files for |
3652 | drivers, networking, core kernel files, filesystem, sound, | 3652 | drivers, networking, core kernel files, filesystem, sound, |
3653 | and so forth. | 3653 | and so forth. |
3654 | The sizes reported by the tool are uncompressed and thus, | 3654 | The sizes reported by the tool are uncompressed, and thus |
3655 | will be smaller by a relatively constant factor in a compressed | 3655 | will be smaller by a relatively constant factor in a compressed |
3656 | kernel image. | 3656 | kernel image. |
3657 | Look to reduce the areas that are large and taking up around | 3657 | Look to reduce the areas that are large and taking up around |
@@ -5162,7 +5162,7 @@ the details. | |||
5162 | Supporting a read-only root filesystem requires that the system and | 5162 | Supporting a read-only root filesystem requires that the system and |
5163 | applications do not try to write to the root filesystem. | 5163 | applications do not try to write to the root filesystem. |
5164 | You must configure all parts of the target system to write | 5164 | You must configure all parts of the target system to write |
5165 | elsewhere, or to gracefully fail in the event of failing to | 5165 | elsewhere, or to gracefully fail in the event of attempting to |
5166 | write to the root filesystem. | 5166 | write to the root filesystem. |
5167 | </note> | 5167 | </note> |
5168 | 5168 | ||