summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2013-11-25 10:53:48 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:21 +0000
commit053d78d43cd1252a570dfc54fcff3920501789b8 (patch)
tree67d02f067349ed01363f115bc0b28bc82f3dadb6 /documentation/dev-manual
parent5156a38f89d5e9af8081af095ac3785ea1a5b171 (diff)
downloadpoky-053d78d43cd1252a570dfc54fcff3920501789b8.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: 94e2422d6e6e408e2dd76b15e1231814b123800d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml30
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 ae11860320..c60c072fef 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2137,7 +2137,7 @@
2137 <filename>.config</filename> file.</para></listitem> 2137 <filename>.config</filename> file.</para></listitem>
2138 <listitem><para>Configuration items that appear twice in the same 2138 <listitem><para>Configuration items that appear twice in the same
2139 configuration fragment.</para></listitem> 2139 configuration fragment.</para></listitem>
2140 <listitem><para>Configuration items tagged as "required" were overridden. 2140 <listitem><para>Configuration items tagged as "required" that were overridden.
2141 </para></listitem> 2141 </para></listitem>
2142 <listitem><para>A board overrides a non-board specific option.</para></listitem> 2142 <listitem><para>A board overrides a non-board specific option.</para></listitem>
2143 <listitem><para>Listed options not valid for the kernel being processed. 2143 <listitem><para>Listed options not valid for the kernel being processed.
@@ -2241,8 +2241,8 @@
2241 <para> 2241 <para>
2242 The first step is to create a layer so you can isolate your changes: 2242 The first step is to create a layer so you can isolate your changes:
2243 <literallayout class='monospaced'> 2243 <literallayout class='monospaced'>
2244 $cd ~/poky 2244 $ cd ~/poky
2245 $mkdir meta-mylayer 2245 $ mkdir meta-mylayer
2246 </literallayout> 2246 </literallayout>
2247 Creating a directory that follows the Yocto Project layer naming 2247 Creating a directory that follows the Yocto Project layer naming
2248 conventions sets up the layer for your changes. 2248 conventions sets up the layer for your changes.
@@ -2309,7 +2309,7 @@
2309 Edit the <filename>init/calibrate.c</filename> file to have the 2309 Edit the <filename>init/calibrate.c</filename> file to have the
2310 following changes: 2310 following changes:
2311 <literallayout class='monospaced'> 2311 <literallayout class='monospaced'>
2312 void __cpuinit calibrate_delay(void) 2312 void calibrate_delay(void)
2313 { 2313 {
2314 unsigned long lpj; 2314 unsigned long lpj;
2315 static bool printed; 2315 static bool printed;
@@ -2675,12 +2675,12 @@
2675 <para> 2675 <para>
2676 The following list presents the overall steps you need to 2676 The following list presents the overall steps you need to
2677 consider and perform to create distributions with smaller 2677 consider and perform to create distributions with smaller
2678 root filesystems, faster boot times, maintain your critical 2678 root filesystems, achieve faster boot times, maintain your critical
2679 functionality, and avoid initial RAM disks: 2679 functionality, and avoid initial RAM disks:
2680 <itemizedlist> 2680 <itemizedlist>
2681 <listitem><para>Determine your goals and guiding 2681 <listitem><para>Determine your goals and guiding
2682 principles.</para></listitem> 2682 principles.</para></listitem>
2683 <listitem><para>Understand what gives your image size. 2683 <listitem><para>Understand what contributes to your image size.
2684 </para></listitem> 2684 </para></listitem>
2685 <listitem><para>Reduce the size of the root filesystem. 2685 <listitem><para>Reduce the size of the root filesystem.
2686 </para></listitem> 2686 </para></listitem>
@@ -2726,7 +2726,7 @@
2726 </section> 2726 </section>
2727 2727
2728 <section id='understand-what-gives-your-image-size'> 2728 <section id='understand-what-gives-your-image-size'>
2729 <title>Understand What Gives Your Image Size</title> 2729 <title>Understand What Contributes to Your Image Size</title>
2730 2730
2731 <para> 2731 <para>
2732 It is easiest to have something to start with when creating 2732 It is easiest to have something to start with when creating
@@ -2754,7 +2754,7 @@
2754 Memory consists of static, dynamic, and temporary memory. 2754 Memory consists of static, dynamic, and temporary memory.
2755 Static memory is the TEXT (code), DATA (initialized data 2755 Static memory is the TEXT (code), DATA (initialized data
2756 in the code), and BSS (uninitialized data) sections. 2756 in the code), and BSS (uninitialized data) sections.
2757 Dynamic memory contains memory that is allocated at runtime, 2757 Dynamic memory represents memory that is allocated at runtime:
2758 stacks, hash tables, and so forth. 2758 stacks, hash tables, and so forth.
2759 Temporary memory is recovered after the boot process. 2759 Temporary memory is recovered after the boot process.
2760 This memory consists of memory used for decompressing 2760 This memory consists of memory used for decompressing
@@ -2830,8 +2830,8 @@
2830 </literallayout> 2830 </literallayout>
2831 You can apply a filter to the script to ignore files under 2831 You can apply a filter to the script to ignore files under
2832 a certain size. 2832 a certain size.
2833 This example filters out anything below 100 Kbytes. 2833 The previous example filters out any files below 100 Kbytes.
2834 The sizes reported by the tool are uncompressed and thus, 2834 The sizes reported by the tool are uncompressed, and thus
2835 will be smaller by a relatively constant factor in a 2835 will be smaller by a relatively constant factor in a
2836 compressed root filesystem. 2836 compressed root filesystem.
2837 When you examine your log file, you can focus on areas of the 2837 When you examine your log file, you can focus on areas of the
@@ -2861,7 +2861,7 @@
2861 </para> 2861 </para>
2862 2862
2863 <para> 2863 <para>
2864 Use the <filename>local.conf</filename> file to make changes. 2864 Use your <filename>local.conf</filename> file to make changes.
2865 For example, to eliminate <filename>udev</filename> and 2865 For example, to eliminate <filename>udev</filename> and
2866 <filename>glib</filename>, set the following in the 2866 <filename>glib</filename>, set the following in the
2867 local configuration file: 2867 local configuration file:
@@ -2880,7 +2880,7 @@
2880 using <filename>initramfs</filename>. 2880 using <filename>initramfs</filename>.
2881 Be aware that <filename>ext3</filename> requires a 1 Mbyte 2881 Be aware that <filename>ext3</filename> requires a 1 Mbyte
2882 journal. 2882 journal.
2883 If you are okay with running read-only you do not need this 2883 If you are okay with running read-only, you do not need this
2884 journal. 2884 journal.
2885 </para> 2885 </para>
2886 2886
@@ -2901,7 +2901,7 @@
2901 aspects. 2901 aspects.
2902 What subsystems do you enable? 2902 What subsystems do you enable?
2903 For what architecture are you building? 2903 For what architecture are you building?
2904 Which drivers do you build by default. 2904 Which drivers do you build by default?
2905 <note>You can modify the kernel source if you want to help 2905 <note>You can modify the kernel source if you want to help
2906 with boot time. 2906 with boot time.
2907 </note> 2907 </note>
@@ -2920,7 +2920,7 @@
2920 taken up with the built-in <filename>.o</filename> files for 2920 taken up with the built-in <filename>.o</filename> files for
2921 drivers, networking, core kernel files, filesystem, sound, 2921 drivers, networking, core kernel files, filesystem, sound,
2922 and so forth. 2922 and so forth.
2923 The sizes reported by the tool are uncompressed and thus, 2923 The sizes reported by the tool are uncompressed, and thus
2924 will be smaller by a relatively constant factor in a compressed 2924 will be smaller by a relatively constant factor in a compressed
2925 kernel image. 2925 kernel image.
2926 Look to reduce the areas that are large and taking up around 2926 Look to reduce the areas that are large and taking up around
@@ -4413,7 +4413,7 @@
4413 Supporting a read-only root filesystem requires that the system and 4413 Supporting a read-only root filesystem requires that the system and
4414 applications do not try to write to the root filesystem. 4414 applications do not try to write to the root filesystem.
4415 You must configure all parts of the target system to write 4415 You must configure all parts of the target system to write
4416 elsewhere, or to gracefully fail in the event of failing to 4416 elsewhere, or to gracefully fail in the event of attempting to
4417 write to the root filesystem. 4417 write to the root filesystem.
4418 </note> 4418 </note>
4419 4419