diff options
Diffstat (limited to 'documentation/sdk-manual/extensible.rst')
-rw-r--r-- | documentation/sdk-manual/extensible.rst | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index d444cad6ea..33032b42a7 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
@@ -438,7 +438,7 @@ command: | |||
438 | 438 | ||
439 | With this scenario, there is no ``srctree`` argument. Consequently, the | 439 | With this scenario, there is no ``srctree`` argument. Consequently, the |
440 | default behavior of the ``devtool modify`` command is to extract | 440 | default behavior of the ``devtool modify`` command is to extract |
441 | the source files pointed to by the ``SRC_URI`` statements into a | 441 | the source files pointed to by the :term:`SRC_URI` statements into a |
442 | local Git structure. Furthermore, the location for the extracted | 442 | local Git structure. Furthermore, the location for the extracted |
443 | source is the default area within the ``devtool`` workspace. The | 443 | source is the default area within the ``devtool`` workspace. The |
444 | result is that the command sets up both the source code and an | 444 | result is that the command sets up both the source code and an |
@@ -446,7 +446,7 @@ command: | |||
446 | original location. | 446 | original location. |
447 | 447 | ||
448 | Additionally, if you have any non-patch local files (i.e. files | 448 | Additionally, if you have any non-patch local files (i.e. files |
449 | referred to with ``file://`` entries in ``SRC_URI`` statement | 449 | referred to with ``file://`` entries in :term:`SRC_URI` statement |
450 | excluding ``*.patch/`` or ``*.diff``), these files are copied to | 450 | excluding ``*.patch/`` or ``*.diff``), these files are copied to |
451 | an ``oe-local-files`` folder under the newly created source tree. | 451 | an ``oe-local-files`` folder under the newly created source tree. |
452 | Copying the files here gives you a convenient area from which you | 452 | Copying the files here gives you a convenient area from which you |
@@ -476,7 +476,7 @@ command: | |||
476 | devtool | 476 | devtool |
477 | command. | 477 | command. |
478 | 478 | ||
479 | As with all extractions, the command uses the recipe's ``SRC_URI`` | 479 | As with all extractions, the command uses the recipe's :term:`SRC_URI` |
480 | statements to locate the source files and any associated patch | 480 | statements to locate the source files and any associated patch |
481 | files. Non-patch files are copied to an ``oe-local-files`` folder | 481 | files. Non-patch files are copied to an ``oe-local-files`` folder |
482 | under the newly created source tree. | 482 | under the newly created source tree. |
@@ -655,18 +655,18 @@ The following diagram shows the common development flow used with the | |||
655 | don't use "-V", the command upgrades the recipe to the latest | 655 | don't use "-V", the command upgrades the recipe to the latest |
656 | version. | 656 | version. |
657 | 657 | ||
658 | If the source files pointed to by the ``SRC_URI`` statement in the | 658 | If the source files pointed to by the :term:`SRC_URI` statement in the |
659 | recipe are in a Git repository, you must provide the "-S" option and | 659 | recipe are in a Git repository, you must provide the "-S" option and |
660 | specify a revision for the software. | 660 | specify a revision for the software. |
661 | 661 | ||
662 | Once ``devtool`` locates the recipe, it uses the ``SRC_URI`` variable | 662 | Once ``devtool`` locates the recipe, it uses the :term:`SRC_URI` variable |
663 | to locate the source code and any local patch files from other | 663 | to locate the source code and any local patch files from other |
664 | developers. The result is that the command sets up the source code, | 664 | developers. The result is that the command sets up the source code, |
665 | the new version of the recipe, and an append file all within the | 665 | the new version of the recipe, and an append file all within the |
666 | workspace. | 666 | workspace. |
667 | 667 | ||
668 | Additionally, if you have any non-patch local files (i.e. files | 668 | Additionally, if you have any non-patch local files (i.e. files |
669 | referred to with ``file://`` entries in ``SRC_URI`` statement | 669 | referred to with ``file://`` entries in :term:`SRC_URI` statement |
670 | excluding ``*.patch/`` or ``*.diff``), these files are copied to an | 670 | excluding ``*.patch/`` or ``*.diff``), these files are copied to an |
671 | ``oe-local-files`` folder under the newly created source tree. | 671 | ``oe-local-files`` folder under the newly created source tree. |
672 | Copying the files here gives you a convenient area from which you can | 672 | Copying the files here gives you a convenient area from which you can |
@@ -676,7 +676,7 @@ The following diagram shows the common development flow used with the | |||
676 | 676 | ||
677 | 2. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen | 677 | 2. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen |
678 | after upgrading the software to a new version. Conflicts occur | 678 | after upgrading the software to a new version. Conflicts occur |
679 | if your recipe specifies some patch files in ``SRC_URI`` that | 679 | if your recipe specifies some patch files in :term:`SRC_URI` that |
680 | conflict with changes made in the new version of the software. For | 680 | conflict with changes made in the new version of the software. For |
681 | such cases, you need to resolve the conflicts by editing the source | 681 | such cases, you need to resolve the conflicts by editing the source |
682 | and following the normal ``git rebase`` conflict resolution process. | 682 | and following the normal ``git rebase`` conflict resolution process. |
@@ -832,7 +832,7 @@ result from naming not being recognized or because the dependency simply | |||
832 | is not available. For cases where the dependency is not available, you | 832 | is not available. For cases where the dependency is not available, you |
833 | must use the ``devtool add`` command to add an additional recipe that | 833 | must use the ``devtool add`` command to add an additional recipe that |
834 | satisfies the dependency. Once you add that recipe, you need to update | 834 | satisfies the dependency. Once you add that recipe, you need to update |
835 | the ``DEPENDS`` variable in the original recipe to include the new | 835 | the :term:`DEPENDS` variable in the original recipe to include the new |
836 | recipe. | 836 | recipe. |
837 | 837 | ||
838 | If you need to add runtime dependencies, you can do so by adding the | 838 | If you need to add runtime dependencies, you can do so by adding the |
@@ -861,7 +861,7 @@ license. If so, the command sets the | |||
861 | :term:`LICENSE` value accordingly. | 861 | :term:`LICENSE` value accordingly. |
862 | You should double-check the value added by the command against the | 862 | You should double-check the value added by the command against the |
863 | documentation or source files for the software you are building and, if | 863 | documentation or source files for the software you are building and, if |
864 | necessary, update that ``LICENSE`` value. | 864 | necessary, update that :term:`LICENSE` value. |
865 | 865 | ||
866 | The ``devtool add`` command also sets the | 866 | The ``devtool add`` command also sets the |
867 | :term:`LIC_FILES_CHKSUM` | 867 | :term:`LIC_FILES_CHKSUM` |
@@ -869,16 +869,16 @@ value to point to all files that appear to be license-related. Realize | |||
869 | that license statements often appear in comments at the top of source | 869 | that license statements often appear in comments at the top of source |
870 | files or within the documentation. In such cases, the command does not | 870 | files or within the documentation. In such cases, the command does not |
871 | recognize those license statements. Consequently, you might need to | 871 | recognize those license statements. Consequently, you might need to |
872 | amend the ``LIC_FILES_CHKSUM`` variable to point to one or more of those | 872 | amend the :term:`LIC_FILES_CHKSUM` variable to point to one or more of those |
873 | comments if present. Setting ``LIC_FILES_CHKSUM`` is particularly | 873 | comments if present. Setting :term:`LIC_FILES_CHKSUM` is particularly |
874 | important for third-party software. The mechanism attempts to ensure | 874 | important for third-party software. The mechanism attempts to ensure |
875 | correct licensing should you upgrade the recipe to a newer upstream | 875 | correct licensing should you upgrade the recipe to a newer upstream |
876 | version in future. Any change in licensing is detected and you receive | 876 | version in future. Any change in licensing is detected and you receive |
877 | an error prompting you to check the license text again. | 877 | an error prompting you to check the license text again. |
878 | 878 | ||
879 | If the ``devtool add`` command cannot determine licensing information, | 879 | If the ``devtool add`` command cannot determine licensing information, |
880 | ``devtool`` sets the ``LICENSE`` value to "CLOSED" and leaves the | 880 | ``devtool`` sets the :term:`LICENSE` value to "CLOSED" and leaves the |
881 | ``LIC_FILES_CHKSUM`` value unset. This behavior allows you to continue | 881 | :term:`LIC_FILES_CHKSUM` value unset. This behavior allows you to continue |
882 | with development even though the settings are unlikely to be correct in | 882 | with development even though the settings are unlikely to be correct in |
883 | all cases. You should check the documentation or source files for the | 883 | all cases. You should check the documentation or source files for the |
884 | software you are building to determine the actual license. | 884 | software you are building to determine the actual license. |
@@ -904,7 +904,7 @@ mind: | |||
904 | hardcoding tools within the toolchain such as ``gcc`` and ``g++``. | 904 | hardcoding tools within the toolchain such as ``gcc`` and ``g++``. |
905 | 905 | ||
906 | - The environment in which Make runs is set up with various standard | 906 | - The environment in which Make runs is set up with various standard |
907 | variables for compilation (e.g. ``CC``, ``CXX``, and so forth) in a | 907 | variables for compilation (e.g. :term:`CC`, :term:`CXX`, and so forth) in a |
908 | similar manner to the environment set up by the SDK's environment | 908 | similar manner to the environment set up by the SDK's environment |
909 | setup script. One easy way to see these variables is to run the | 909 | setup script. One easy way to see these variables is to run the |
910 | ``devtool build`` command on the recipe and then look in | 910 | ``devtool build`` command on the recipe and then look in |
@@ -920,7 +920,7 @@ mind: | |||
920 | the command line, add the variable setting to | 920 | the command line, add the variable setting to |
921 | :term:`EXTRA_OEMAKE` or | 921 | :term:`EXTRA_OEMAKE` or |
922 | :term:`PACKAGECONFIG_CONFARGS` | 922 | :term:`PACKAGECONFIG_CONFARGS` |
923 | within the recipe. Here is an example using ``EXTRA_OEMAKE``:: | 923 | within the recipe. Here is an example using :term:`EXTRA_OEMAKE`:: |
924 | 924 | ||
925 | EXTRA_OEMAKE += "'CC=${CC}' 'CXX=${CXX}'" | 925 | EXTRA_OEMAKE += "'CC=${CC}' 'CXX=${CXX}'" |
926 | 926 | ||
@@ -1086,20 +1086,20 @@ extras specified by | |||
1086 | :term:`EXTRA_OECONF` or | 1086 | :term:`EXTRA_OECONF` or |
1087 | :term:`PACKAGECONFIG_CONFARGS` | 1087 | :term:`PACKAGECONFIG_CONFARGS` |
1088 | set within the recipe. If you wish to pass additional options, add them | 1088 | set within the recipe. If you wish to pass additional options, add them |
1089 | to ``EXTRA_OECONF`` or ``PACKAGECONFIG_CONFARGS``. Other supported build | 1089 | to :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS`. Other supported build |
1090 | tools have similar variables (e.g. | 1090 | tools have similar variables (e.g. |
1091 | :term:`EXTRA_OECMAKE` for | 1091 | :term:`EXTRA_OECMAKE` for |
1092 | CMake, :term:`EXTRA_OESCONS` | 1092 | CMake, :term:`EXTRA_OESCONS` |
1093 | for Scons, and so forth). If you need to pass anything on the ``make`` | 1093 | for Scons, and so forth). If you need to pass anything on the ``make`` |
1094 | command line, you can use ``EXTRA_OEMAKE`` or the | 1094 | command line, you can use :term:`EXTRA_OEMAKE` or the |
1095 | :term:`PACKAGECONFIG_CONFARGS` | 1095 | :term:`PACKAGECONFIG_CONFARGS` |
1096 | variables to do so. | 1096 | variables to do so. |
1097 | 1097 | ||
1098 | You can use the ``devtool configure-help`` command to help you set the | 1098 | You can use the ``devtool configure-help`` command to help you set the |
1099 | arguments listed in the previous paragraph. The command determines the | 1099 | arguments listed in the previous paragraph. The command determines the |
1100 | exact options being passed, and shows them to you along with any custom | 1100 | exact options being passed, and shows them to you along with any custom |
1101 | arguments specified through ``EXTRA_OECONF`` or | 1101 | arguments specified through :term:`EXTRA_OECONF` or |
1102 | ``PACKAGECONFIG_CONFARGS``. If applicable, the command also shows you | 1102 | :term:`PACKAGECONFIG_CONFARGS`. If applicable, the command also shows you |
1103 | the output of the configure script's "--help" option as a | 1103 | the output of the configure script's "--help" option as a |
1104 | reference. | 1104 | reference. |
1105 | 1105 | ||
@@ -1151,16 +1151,16 @@ the ``oe-workdir/packages-split`` directory, which contains a | |||
1151 | subdirectory for each package. Apart from some advanced cases, the | 1151 | subdirectory for each package. Apart from some advanced cases, the |
1152 | :term:`PACKAGES` and | 1152 | :term:`PACKAGES` and |
1153 | :term:`FILES` variables controls | 1153 | :term:`FILES` variables controls |
1154 | splitting. The ``PACKAGES`` variable lists all of the packages to be | 1154 | splitting. The :term:`PACKAGES` variable lists all of the packages to be |
1155 | produced, while the ``FILES`` variable specifies which files to include | 1155 | produced, while the :term:`FILES` variable specifies which files to include |
1156 | in each package by using an override to specify the package. For | 1156 | in each package by using an override to specify the package. For |
1157 | example, ``FILES_${PN}`` specifies the files to go into the main package | 1157 | example, ``FILES_${PN}`` specifies the files to go into the main package |
1158 | (i.e. the main package has the same name as the recipe and | 1158 | (i.e. the main package has the same name as the recipe and |
1159 | ``${``\ :term:`PN`\ ``}`` evaluates to the | 1159 | ``${``\ :term:`PN`\ ``}`` evaluates to the |
1160 | recipe name). The order of the ``PACKAGES`` value is significant. For | 1160 | recipe name). The order of the :term:`PACKAGES` value is significant. For |
1161 | each installed file, the first package whose ``FILES`` value matches the | 1161 | each installed file, the first package whose :term:`FILES` value matches the |
1162 | file is the package into which the file goes. Both the ``PACKAGES`` and | 1162 | file is the package into which the file goes. Both the :term:`PACKAGES` and |
1163 | ``FILES`` variables have default values. Consequently, you might find | 1163 | :term:`FILES` variables have default values. Consequently, you might find |
1164 | you do not even need to set these variables in your recipe unless the | 1164 | you do not even need to set these variables in your recipe unless the |
1165 | software the recipe is building installs files into non-standard | 1165 | software the recipe is building installs files into non-standard |
1166 | locations. | 1166 | locations. |