diff options
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r-- | documentation/kernel-dev/common.rst | 45 | ||||
-rw-r--r-- | documentation/kernel-dev/concepts-appx.rst | 3 | ||||
-rw-r--r-- | documentation/kernel-dev/intro.rst | 4 | ||||
-rw-r--r-- | documentation/kernel-dev/maint-appx.rst | 5 |
4 files changed, 23 insertions, 34 deletions
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 0a1819ceae..690f61110b 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst | |||
@@ -66,19 +66,15 @@ section: | |||
66 | (i.e. ``poky``) have been cloned using Git and the local repository is named | 66 | (i.e. ``poky``) have been cloned using Git and the local repository is named |
67 | "poky". | 67 | "poky". |
68 | 68 | ||
69 | 2. *Prepare Your local.conf File:* By default, the | 69 | 2. *Prepare Your local.conf File:* By default, the :term:`MACHINE` variable |
70 | :term:`MACHINE` variable is set to | 70 | is set to "qemux86-64", which is fine if you are building for the QEMU |
71 | "qemux86-64", which is fine if you are building for the QEMU emulator | 71 | emulator in 64-bit mode. However, if you are not, you need to set the |
72 | in 64-bit mode. However, if you are not, you need to set the | ||
73 | :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file | 72 | :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file |
74 | found in the | 73 | found in the :term:`Build Directory` (i.e. ``poky/build`` in this example). |
75 | :term:`Build Directory` (i.e. | ||
76 | ``poky/build`` in this example). | ||
77 | 74 | ||
78 | Also, since you are preparing to work on the kernel image, you need | 75 | Also, since you are preparing to work on the kernel image, you need |
79 | to set the | 76 | to set the :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` variable to include |
80 | :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` | 77 | kernel modules. |
81 | variable to include kernel modules. | ||
82 | 78 | ||
83 | In this example we wish to build for qemux86 so we must set the | 79 | In this example we wish to build for qemux86 so we must set the |
84 | :term:`MACHINE` variable to "qemux86" and also add the "kernel-modules". | 80 | :term:`MACHINE` variable to "qemux86" and also add the "kernel-modules". |
@@ -186,14 +182,11 @@ section: | |||
186 | (i.e. ``poky``) have been cloned using Git and the local repository is named | 182 | (i.e. ``poky``) have been cloned using Git and the local repository is named |
187 | "poky". | 183 | "poky". |
188 | 184 | ||
189 | 2. *Prepare Your local.conf File:* By default, the | 185 | 2. *Prepare Your local.conf File:* By default, the :term:`MACHINE` variable is |
190 | :term:`MACHINE` variable is set to | 186 | set to "qemux86-64", which is fine if you are building for the QEMU emulator |
191 | "qemux86-64", which is fine if you are building for the QEMU emulator | 187 | in 64-bit mode. However, if you are not, you need to set the :term:`MACHINE` |
192 | in 64-bit mode. However, if you are not, you need to set the | 188 | variable appropriately in your ``conf/local.conf`` file found in the |
193 | :term:`MACHINE` variable appropriately in your ``conf/local.conf`` file | 189 | :term:`Build Directory` (i.e. ``poky/build`` in this example). |
194 | found in the | ||
195 | :term:`Build Directory` (i.e. | ||
196 | ``poky/build`` in this example). | ||
197 | 190 | ||
198 | Also, since you are preparing to work on the kernel image, you need | 191 | Also, since you are preparing to work on the kernel image, you need |
199 | to set the | 192 | to set the |
@@ -836,8 +829,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se | |||
836 | 829 | ||
837 | 8. *Build the Image With Your Modified Kernel:* You can now build an | 830 | 8. *Build the Image With Your Modified Kernel:* You can now build an |
838 | image that includes your kernel patches. Execute the following | 831 | image that includes your kernel patches. Execute the following |
839 | command from your | 832 | command from your :term:`Build Directory` in the terminal |
840 | :term:`Build Directory` in the terminal | ||
841 | set up to run BitBake:: | 833 | set up to run BitBake:: |
842 | 834 | ||
843 | $ cd poky/build | 835 | $ cd poky/build |
@@ -1057,9 +1049,8 @@ To use the ``menuconfig`` tool in the Yocto Project development | |||
1057 | environment, you must do the following: | 1049 | environment, you must do the following: |
1058 | 1050 | ||
1059 | - Because you launch ``menuconfig`` using BitBake, you must be sure to | 1051 | - Because you launch ``menuconfig`` using BitBake, you must be sure to |
1060 | set up your environment by running the | 1052 | set up your environment by running the :ref:`structure-core-script` script |
1061 | :ref:`structure-core-script` script found in | 1053 | found in the :term:`Build Directory`. |
1062 | the :term:`Build Directory`. | ||
1063 | 1054 | ||
1064 | - You must be sure of the state of your build's configuration in the | 1055 | - You must be sure of the state of your build's configuration in the |
1065 | :term:`Source Directory`. | 1056 | :term:`Source Directory`. |
@@ -1111,10 +1102,10 @@ can find the option under "Processor Type and Features". To deselect | |||
1111 | Multi-Processing Support" and enter "N" to clear the asterisk. When you | 1102 | Multi-Processing Support" and enter "N" to clear the asterisk. When you |
1112 | are finished, exit out and save the change. | 1103 | are finished, exit out and save the change. |
1113 | 1104 | ||
1114 | Saving the selections updates the ``.config`` configuration file. This | 1105 | Saving the selections updates the ``.config`` configuration file. This is the |
1115 | is the file that the OpenEmbedded build system uses to configure the | 1106 | file that the OpenEmbedded build system uses to configure the kernel during |
1116 | kernel during the build. You can find and examine this file in the Build | 1107 | the build. You can find and examine this file in the :term:`Build Directory` |
1117 | Directory in ``tmp/work/``. The actual ``.config`` is located in the | 1108 | in ``tmp/work/``. The actual ``.config`` is located in the |
1118 | area where the specific kernel is built. For example, if you were | 1109 | area where the specific kernel is built. For example, if you were |
1119 | building a Linux Yocto kernel based on the ``linux-yocto-4.12`` kernel | 1110 | building a Linux Yocto kernel based on the ``linux-yocto-4.12`` kernel |
1120 | and you were building a QEMU image targeted for ``x86`` architecture, | 1111 | and you were building a QEMU image targeted for ``x86`` architecture, |
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst index 63c5124a57..6a2fe4bb0b 100644 --- a/documentation/kernel-dev/concepts-appx.rst +++ b/documentation/kernel-dev/concepts-appx.rst | |||
@@ -319,8 +319,7 @@ image. | |||
319 | 319 | ||
320 | The following figure shows the temporary file structure created on your | 320 | The following figure shows the temporary file structure created on your |
321 | host system when you build the kernel using BitBake. This | 321 | host system when you build the kernel using BitBake. This |
322 | :term:`Build Directory` contains all the | 322 | :term:`Build Directory` contains all the source files used during the build. |
323 | source files used during the build. | ||
324 | 323 | ||
325 | .. image:: figures/kernel-overview-2-generic.png | 324 | .. image:: figures/kernel-overview-2-generic.png |
326 | :align: center | 325 | :align: center |
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index 4ff4dc7d35..267b7e7797 100644 --- a/documentation/kernel-dev/intro.rst +++ b/documentation/kernel-dev/intro.rst | |||
@@ -134,7 +134,7 @@ general information and references for further information. | |||
134 | 3. *Make Changes to the Kernel Source Code if applicable:* Modifying the | 134 | 3. *Make Changes to the Kernel Source Code if applicable:* Modifying the |
135 | kernel does not always mean directly changing source files. However, | 135 | kernel does not always mean directly changing source files. However, |
136 | if you have to do this, you make the changes to the files in the | 136 | if you have to do this, you make the changes to the files in the |
137 | Yocto's Build Directory if you are using ``devtool``. For more | 137 | Yocto's :term:`Build Directory` if you are using ``devtool``. For more |
138 | information, see the | 138 | information, see the |
139 | ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" | 139 | ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" |
140 | section. | 140 | section. |
@@ -155,7 +155,7 @@ general information and references for further information. | |||
155 | .. note:: | 155 | .. note:: |
156 | 156 | ||
157 | Try to resist the temptation to directly edit an existing ``.config`` | 157 | Try to resist the temptation to directly edit an existing ``.config`` |
158 | file, which is found in the Build Directory among the source code | 158 | file, which is found in the :term:`Build Directory` among the source code |
159 | used for the build. Doing so, can produce unexpected results when | 159 | used for the build. Doing so, can produce unexpected results when |
160 | the OpenEmbedded build system regenerates the configuration file. | 160 | the OpenEmbedded build system regenerates the configuration file. |
161 | 161 | ||
diff --git a/documentation/kernel-dev/maint-appx.rst b/documentation/kernel-dev/maint-appx.rst index d968c856f6..6aa2fb7cf1 100644 --- a/documentation/kernel-dev/maint-appx.rst +++ b/documentation/kernel-dev/maint-appx.rst | |||
@@ -229,6 +229,5 @@ This behavior means that all the generated files for a particular | |||
229 | machine or BSP are now in the build tree directory. The files include | 229 | machine or BSP are now in the build tree directory. The files include |
230 | the final ``.config`` file, all the ``.o`` files, the ``.a`` files, and | 230 | the final ``.config`` file, all the ``.o`` files, the ``.a`` files, and |
231 | so forth. Since each machine or BSP has its own separate | 231 | so forth. Since each machine or BSP has its own separate |
232 | :term:`Build Directory` in its own separate | 232 | :term:`Build Directory` in its own separate branch of the Git repository, |
233 | branch of the Git repository, you can easily switch between different | 233 | you can easily switch between different builds. |
234 | builds. | ||