diff options
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 79 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 12 |
2 files changed, 58 insertions, 33 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 0c66a7c232..3922c8f0f4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -3548,7 +3548,7 @@ | |||
3548 | 3548 | ||
3549 | <para> | 3549 | <para> |
3550 | As part of the kernel build process, the | 3550 | As part of the kernel build process, the |
3551 | <filename>kernel_configcheck</filename> task runs. | 3551 | <filename>do_kernel_configcheck</filename> task runs. |
3552 | This task validates the kernel configuration by checking the final | 3552 | This task validates the kernel configuration by checking the final |
3553 | <filename>.config</filename> file against the input files. | 3553 | <filename>.config</filename> file against the input files. |
3554 | During the check, the task produces warning messages for the following | 3554 | During the check, the task produces warning messages for the following |
@@ -3565,8 +3565,9 @@ | |||
3565 | In other words, the option does not appear anywhere.</para></listitem> | 3565 | In other words, the option does not appear anywhere.</para></listitem> |
3566 | </itemizedlist> | 3566 | </itemizedlist> |
3567 | <note> | 3567 | <note> |
3568 | The <filename>kernel_configcheck</filename> task can also optionally report | 3568 | The <filename>do_kernel_configcheck</filename> task can |
3569 | if an option is overridden during processing. | 3569 | also optionally report if an option is overridden during |
3570 | processing. | ||
3570 | </note> | 3571 | </note> |
3571 | </para> | 3572 | </para> |
3572 | 3573 | ||
@@ -3580,29 +3581,45 @@ | |||
3580 | <para> | 3581 | <para> |
3581 | To streamline the configuration, do the following: | 3582 | To streamline the configuration, do the following: |
3582 | <orderedlist> | 3583 | <orderedlist> |
3583 | <listitem><para>Start with a full configuration that you know | 3584 | <listitem><para>Start with a full configuration that you |
3584 | works - it builds and boots successfully. | 3585 | know works - it builds and boots successfully. |
3585 | This configuration file will be your baseline.</para></listitem> | 3586 | This configuration file will be your baseline. |
3586 | <listitem><para>Separately run the <filename>configme</filename> and | 3587 | </para></listitem> |
3587 | <filename>kernel_configcheck</filename> tasks.</para></listitem> | 3588 | <listitem><para>Separately run the |
3589 | <filename>do_configme</filename> and | ||
3590 | <filename>do_kernel_configcheck</filename> tasks. | ||
3591 | </para></listitem> | ||
3588 | <listitem><para>Take the resulting list of files from the | 3592 | <listitem><para>Take the resulting list of files from the |
3589 | <filename>kernel_configcheck</filename> task warnings and do the following: | 3593 | <filename>do_kernel_configcheck</filename> task |
3594 | warnings and do the following: | ||
3590 | <itemizedlist> | 3595 | <itemizedlist> |
3591 | <listitem><para>Drop values that are redefined in the fragment but do not | 3596 | <listitem><para> |
3592 | change the final <filename>.config</filename> file.</para></listitem> | 3597 | Drop values that are redefined in the fragment |
3593 | <listitem><para>Analyze and potentially drop values from the | 3598 | but do not change the final |
3594 | <filename>.config</filename> file that override required | 3599 | <filename>.config</filename> file. |
3595 | configurations.</para></listitem> | 3600 | </para></listitem> |
3596 | <listitem><para>Analyze and potentially remove non-board specific options. | 3601 | <listitem><para> |
3602 | Analyze and potentially drop values from the | ||
3603 | <filename>.config</filename> file that override | ||
3604 | required configurations. | ||
3605 | </para></listitem> | ||
3606 | <listitem><para> | ||
3607 | Analyze and potentially remove non-board | ||
3608 | specific options. | ||
3609 | </para></listitem> | ||
3610 | <listitem><para> | ||
3611 | Remove repeated and invalid options. | ||
3597 | </para></listitem> | 3612 | </para></listitem> |
3598 | <listitem><para>Remove repeated and invalid options.</para></listitem> | ||
3599 | </itemizedlist></para></listitem> | 3613 | </itemizedlist></para></listitem> |
3600 | <listitem><para>After you have worked through the output of the kernel configuration | 3614 | <listitem><para> |
3601 | audit, you can re-run the <filename>configme</filename> | 3615 | After you have worked through the output of the kernel |
3602 | and <filename>kernel_configcheck</filename> tasks to see the results of your | 3616 | configuration audit, you can re-run the |
3603 | changes. | 3617 | <filename>do_configme</filename> and |
3604 | If you have more issues, you can deal with them as described in the | 3618 | <filename>do_kernel_configcheck</filename> tasks to |
3605 | previous step.</para></listitem> | 3619 | see the results of your changes. |
3620 | If you have more issues, you can deal with them as | ||
3621 | described in the previous step. | ||
3622 | </para></listitem> | ||
3606 | </orderedlist> | 3623 | </orderedlist> |
3607 | </para> | 3624 | </para> |
3608 | 3625 | ||
@@ -5149,14 +5166,18 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
5149 | <section id="usingpoky-configuring-DISTRO_PN_ALIAS"> | 5166 | <section id="usingpoky-configuring-DISTRO_PN_ALIAS"> |
5150 | <title>Handling a Package Name Alias</title> | 5167 | <title>Handling a Package Name Alias</title> |
5151 | <para> | 5168 | <para> |
5152 | Sometimes a package name you are using might exist under an alias or as a similarly named | 5169 | Sometimes a package name you are using might exist under |
5153 | package in a different distribution. | 5170 | an alias or as a similarly named package in a different |
5154 | The OpenEmbedded build system implements a <filename>distro_check</filename> | 5171 | distribution. |
5172 | The OpenEmbedded build system implements a | ||
5173 | <filename>do_distro_check</filename> | ||
5155 | task that automatically connects to major distributions | 5174 | task that automatically connects to major distributions |
5156 | and checks for these situations. | 5175 | and checks for these situations. |
5157 | If the package exists under a different name in a different distribution, you get a | 5176 | If the package exists under a different name in a different |
5158 | <filename>distro_check</filename> mismatch. | 5177 | distribution, you get a <filename>distro_check</filename> |
5159 | You can resolve this problem by defining a per-distro recipe name alias using the | 5178 | mismatch. |
5179 | You can resolve this problem by defining a per-distro recipe | ||
5180 | name alias using the | ||
5160 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> | 5181 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> |
5161 | variable. | 5182 | variable. |
5162 | </para> | 5183 | </para> |
@@ -6922,7 +6943,7 @@ Gateways via their Web Interfaces</ulink>"</emphasis> | |||
6922 | Returns "True" if <filename>pkg</filename> is in the | 6943 | Returns "True" if <filename>pkg</filename> is in the |
6923 | installed package list of the image, which is based | 6944 | installed package list of the image, which is based |
6924 | on the manifest file that is generated during the | 6945 | on the manifest file that is generated during the |
6925 | <filename>do.rootfs</filename> task. | 6946 | <filename>do_rootfs</filename> task. |
6926 | </para></listitem> | 6947 | </para></listitem> |
6927 | <listitem><para><emphasis><filename>hasFeature(feature)</filename>:</emphasis> | 6948 | <listitem><para><emphasis><filename>hasFeature(feature)</filename>:</emphasis> |
6928 | Returns "True" if the feature is in | 6949 | Returns "True" if the feature is in |
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 4fd4c4e1e3..59e19a2bae 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -1773,8 +1773,10 @@ | |||
1773 | Make your changes in the temporary source code to the files you added | 1773 | Make your changes in the temporary source code to the files you added |
1774 | to the patch.</para></listitem> | 1774 | to the patch.</para></listitem> |
1775 | <listitem><para><emphasis>Test Your Changes:</emphasis> | 1775 | <listitem><para><emphasis>Test Your Changes:</emphasis> |
1776 | Once you have modified the source code, the easiest way to test your changes | 1776 | Once you have modified the source code, the easiest way to |
1777 | is by calling the <filename>compile</filename> task as shown in the following example: | 1777 | your changes is by calling the |
1778 | <filename>do_compile</filename> task as shown in the | ||
1779 | following example: | ||
1778 | <literallayout class='monospaced'> | 1780 | <literallayout class='monospaced'> |
1779 | $ bitbake -c compile -f <name_of_package> | 1781 | $ bitbake -c compile -f <name_of_package> |
1780 | </literallayout> | 1782 | </literallayout> |
@@ -1870,8 +1872,10 @@ | |||
1870 | <listitem><para><emphasis>Edit the Files:</emphasis> | 1872 | <listitem><para><emphasis>Edit the Files:</emphasis> |
1871 | Make your changes to the temporary source code.</para></listitem> | 1873 | Make your changes to the temporary source code.</para></listitem> |
1872 | <listitem><para><emphasis>Test Your Changes:</emphasis> | 1874 | <listitem><para><emphasis>Test Your Changes:</emphasis> |
1873 | Once you have modified the source code, the easiest way to test your changes | 1875 | Once you have modified the source code, the easiest way |
1874 | is by calling the <filename>compile</filename> task as shown in the following example: | 1876 | to test your changes is by calling the |
1877 | <filename>do_compile</filename> task as shown in the | ||
1878 | following example: | ||
1875 | <literallayout class='monospaced'> | 1879 | <literallayout class='monospaced'> |
1876 | $ bitbake -c compile -f <name_of_package> | 1880 | $ bitbake -c compile -f <name_of_package> |
1877 | </literallayout> | 1881 | </literallayout> |