diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-23 12:16:28 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:29 +0000 |
commit | ebc7de094881dd8f2450aa4fdf548f2e9c835df1 (patch) | |
tree | aa6debbfa99730e284e65a5d982d21a9e897003a /documentation | |
parent | 30b91e6d891fbfa6a44487a27b8ceb5618157614 (diff) | |
download | poky-ebc7de094881dd8f2450aa4fdf548f2e9c835df1.tar.gz |
ref-manual, dev-manual: Moved "Speeding Build" to dev-manual
Fixes [YOCTO #12370]
The section on "Speeding Up a Build" that was in the ref-manual
needed to be in the dev-manual as it is a "how-to" section.
Moved it.
(From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 36 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 8 |
2 files changed, 19 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 21f5e9ed5e..27237c0d20 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -8,10 +8,8 @@ | |||
8 | 8 | ||
9 | <para> | 9 | <para> |
10 | This chapter provides procedures related to getting set up to use the | 10 | This chapter provides procedures related to getting set up to use the |
11 | Yocto Project. | 11 | Yocto Project, working with Yocto Project source files, and building |
12 | For a more front-to-end process that takes you from minimally preparing | 12 | an image. |
13 | a build host through building an image, see the | ||
14 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | ||
15 | </para> | 13 | </para> |
16 | 14 | ||
17 | <section id='setting-up-the-development-host-to-use-the-yocto-project'> | 15 | <section id='setting-up-the-development-host-to-use-the-yocto-project'> |
@@ -857,7 +855,7 @@ | |||
857 | information: | 855 | information: |
858 | <itemizedlist> | 856 | <itemizedlist> |
859 | <listitem><para> | 857 | <listitem><para> |
860 | <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename>:</link> | 858 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename>:</ulink> |
861 | The maximum number of threads BitBake simultaneously executes. | 859 | The maximum number of threads BitBake simultaneously executes. |
862 | </para></listitem> | 860 | </para></listitem> |
863 | <listitem><para> | 861 | <listitem><para> |
@@ -865,18 +863,18 @@ | |||
865 | The number of threads BitBake uses during parsing. | 863 | The number of threads BitBake uses during parsing. |
866 | </para></listitem> | 864 | </para></listitem> |
867 | <listitem><para> | 865 | <listitem><para> |
868 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename>:</link> | 866 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename>:</ulink> |
869 | Extra options passed to the <filename>make</filename> command | 867 | Extra options passed to the <filename>make</filename> command |
870 | during the | 868 | during the |
871 | <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> | 869 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-compile'><filename>do_compile</filename></ulink> |
872 | task in order to specify parallel compilation on the | 870 | task in order to specify parallel compilation on the |
873 | local build host. | 871 | local build host. |
874 | </para></listitem> | 872 | </para></listitem> |
875 | <listitem><para> | 873 | <listitem><para> |
876 | <link linkend='var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename>:</link> | 874 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename>:</ulink> |
877 | Extra options passed to the <filename>make</filename> command | 875 | Extra options passed to the <filename>make</filename> command |
878 | during the | 876 | during the |
879 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> | 877 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink> |
880 | task in order to specify parallel installation on the | 878 | task in order to specify parallel installation on the |
881 | local build host. | 879 | local build host. |
882 | </para></listitem> | 880 | </para></listitem> |
@@ -923,7 +921,7 @@ | |||
923 | </para></listitem> | 921 | </para></listitem> |
924 | <listitem><para> | 922 | <listitem><para> |
925 | Using <filename>tmpfs</filename> for | 923 | Using <filename>tmpfs</filename> for |
926 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | 924 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> |
927 | as a temporary file system: | 925 | as a temporary file system: |
928 | While this can help speed up the build, the benefits are | 926 | While this can help speed up the build, the benefits are |
929 | limited due to the compiler using | 927 | limited due to the compiler using |
@@ -932,23 +930,24 @@ | |||
932 | <filename>sync()</filename> calls into the | 930 | <filename>sync()</filename> calls into the |
933 | file system on the principle that if there was a significant | 931 | file system on the principle that if there was a significant |
934 | failure, the | 932 | failure, the |
935 | <link linkend='build-directory'>Build Directory</link> | 933 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
936 | contents could easily be rebuilt. | 934 | contents could easily be rebuilt. |
937 | </para></listitem> | 935 | </para></listitem> |
938 | <listitem><para> | 936 | <listitem><para> |
939 | Inheriting the | 937 | Inheriting the |
940 | <link linkend='ref-classes-rm-work'><filename>rm_work</filename></link> | 938 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-rm-work'><filename>rm_work</filename></ulink> |
941 | class: | 939 | class: |
942 | Inheriting this class has shown to speed up builds due to | 940 | Inheriting this class has shown to speed up builds due to |
943 | significantly lower amounts of data stored in the data | 941 | significantly lower amounts of data stored in the data |
944 | cache as well as on disk. | 942 | cache as well as on disk. |
945 | Inheriting this class also makes cleanup of | 943 | Inheriting this class also makes cleanup of |
946 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | 944 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink> |
947 | faster, at the expense of being easily able to dive into the | 945 | faster, at the expense of being easily able to dive into the |
948 | source code. | 946 | source code. |
949 | File system maintainers have recommended that the fastest way | 947 | File system maintainers have recommended that the fastest way |
950 | to clean up large numbers of files is to reformat partitions | 948 | to clean up large numbers of files is to reformat partitions |
951 | rather than delete files due to the linear nature of partitions. | 949 | rather than delete files due to the linear nature of |
950 | partitions. | ||
952 | This, of course, assumes you structure the disk partitions and | 951 | This, of course, assumes you structure the disk partitions and |
953 | file systems in a way that this is practical. | 952 | file systems in a way that this is practical. |
954 | </para></listitem> | 953 | </para></listitem> |
@@ -958,7 +957,7 @@ | |||
958 | <itemizedlist> | 957 | <itemizedlist> |
959 | <listitem><para> | 958 | <listitem><para> |
960 | Remove items from | 959 | Remove items from |
961 | <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> | 960 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink> |
962 | that you might not need. | 961 | that you might not need. |
963 | </para></listitem> | 962 | </para></listitem> |
964 | <listitem><para> | 963 | <listitem><para> |
@@ -967,7 +966,7 @@ | |||
967 | disabling the <filename>*-dbg</filename> package generation | 966 | disabling the <filename>*-dbg</filename> package generation |
968 | can speed up the build. | 967 | can speed up the build. |
969 | You can disable this generation by setting the | 968 | You can disable this generation by setting the |
970 | <link linkend='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename></link> | 969 | <ulink url='&YOCTO_DOCS_REF_URL;#var-INHIBIT_PACKAGE_DEBUG_SPLIT'><filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename></ulink> |
971 | variable to "1". | 970 | variable to "1". |
972 | </para></listitem> | 971 | </para></listitem> |
973 | <listitem><para> | 972 | <listitem><para> |
@@ -1000,11 +999,6 @@ | |||
1000 | </itemizedlist> | 999 | </itemizedlist> |
1001 | </para> | 1000 | </para> |
1002 | </section> | 1001 | </section> |
1003 | |||
1004 | |||
1005 | |||
1006 | |||
1007 | |||
1008 | </chapter> | 1002 | </chapter> |
1009 | <!-- | 1003 | <!-- |
1010 | vim: expandtab tw=80 ts=4 | 1004 | vim: expandtab tw=80 ts=4 |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index c784bd7424..334336880b 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -972,8 +972,8 @@ | |||
972 | 972 | ||
973 | <para> | 973 | <para> |
974 | For more information on speeding up builds, see the | 974 | For more information on speeding up builds, see the |
975 | "<link linkend='speeding-up-the-build'>Speeding Up the Build</link>" | 975 | "<ulink url='&YOCTO_DOCS_DEV_URL;#speeding-up-the-build'>Speeding Up the Build</ulink>" |
976 | section. | 976 | section in the Yocto Project Development Tasks Manual. |
977 | </para> | 977 | </para> |
978 | </glossdef> | 978 | </glossdef> |
979 | </glossentry> | 979 | </glossentry> |
@@ -10170,8 +10170,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10170 | 10170 | ||
10171 | <para> | 10171 | <para> |
10172 | For more information on speeding up builds, see the | 10172 | For more information on speeding up builds, see the |
10173 | "<link linkend='speeding-up-the-build'>Speeding Up the Build</link>" | 10173 | "<ulink url='&YOCTO_DOCS_DEV_URL;#speeding-up-the-build'>Speeding Up the Build</ulink>" |
10174 | section. | 10174 | section in the Yocto Project Development Tasks Manual. |
10175 | </para> | 10175 | </para> |
10176 | </glossdef> | 10176 | </glossdef> |
10177 | </glossentry> | 10177 | </glossentry> |