diff options
Diffstat (limited to 'documentation/dev-manual/common-tasks.rst')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 3d96399047..a6e61c891f 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -1731,7 +1731,7 @@ your software is built: | |||
1731 | 1731 | ||
1732 | If you need to install one or more custom CMake toolchain files | 1732 | If you need to install one or more custom CMake toolchain files |
1733 | that are supplied by the application you are building, install the | 1733 | that are supplied by the application you are building, install the |
1734 | files to ``${D}${datadir}/cmake/Modules`` during ``do_install``. | 1734 | files to ``${D}${datadir}/cmake/Modules`` during :ref:`ref-tasks-install`. |
1735 | 1735 | ||
1736 | - *Other:* If your source files do not have a ``configure.ac`` or | 1736 | - *Other:* If your source files do not have a ``configure.ac`` or |
1737 | ``CMakeLists.txt`` file, then your software is built using some | 1737 | ``CMakeLists.txt`` file, then your software is built using some |
@@ -1888,7 +1888,7 @@ Here are some common issues that cause failures. | |||
1888 | Installing | 1888 | Installing |
1889 | ---------- | 1889 | ---------- |
1890 | 1890 | ||
1891 | During ``do_install``, the task copies the built files along with their | 1891 | During :ref:`ref-tasks-install`, the task copies the built files along with their |
1892 | hierarchy to locations that would mirror their locations on the target | 1892 | hierarchy to locations that would mirror their locations on the target |
1893 | device. The installation process copies files from the | 1893 | device. The installation process copies files from the |
1894 | ``${``\ :term:`S`\ ``}``, | 1894 | ``${``\ :term:`S`\ ``}``, |
@@ -1906,14 +1906,14 @@ the software being built: | |||
1906 | - *Autotools and CMake:* If the software your recipe is building uses | 1906 | - *Autotools and CMake:* If the software your recipe is building uses |
1907 | Autotools or CMake, the OpenEmbedded build system understands how to | 1907 | Autotools or CMake, the OpenEmbedded build system understands how to |
1908 | install the software. Consequently, you do not have to have a | 1908 | install the software. Consequently, you do not have to have a |
1909 | ``do_install`` task as part of your recipe. You just need to make | 1909 | :ref:`ref-tasks-install` task as part of your recipe. You just need to make |
1910 | sure the install portion of the build completes with no issues. | 1910 | sure the install portion of the build completes with no issues. |
1911 | However, if you wish to install additional files not already being | 1911 | However, if you wish to install additional files not already being |
1912 | installed by ``make install``, you should do this using a | 1912 | installed by ``make install``, you should do this using a |
1913 | ``do_install:append`` function using the install command as described | 1913 | ``do_install:append`` function using the install command as described |
1914 | in the "Manual" bulleted item later in this list. | 1914 | in the "Manual" bulleted item later in this list. |
1915 | 1915 | ||
1916 | - *Other (using* ``make install``\ *)*: You need to define a ``do_install`` | 1916 | - *Other (using* ``make install``\ *)*: You need to define a :ref:`ref-tasks-install` |
1917 | function in your recipe. The function should call | 1917 | function in your recipe. The function should call |
1918 | ``oe_runmake install`` and will likely need to pass in the | 1918 | ``oe_runmake install`` and will likely need to pass in the |
1919 | destination directory as well. How you pass that path is dependent on | 1919 | destination directory as well. How you pass that path is dependent on |
@@ -1923,7 +1923,7 @@ the software being built: | |||
1923 | For an example recipe using ``make install``, see the | 1923 | For an example recipe using ``make install``, see the |
1924 | ":ref:`dev-manual/common-tasks:makefile-based package`" section. | 1924 | ":ref:`dev-manual/common-tasks:makefile-based package`" section. |
1925 | 1925 | ||
1926 | - *Manual:* You need to define a ``do_install`` function in your | 1926 | - *Manual:* You need to define a :ref:`ref-tasks-install` function in your |
1927 | recipe. The function must first use ``install -d`` to create the | 1927 | recipe. The function must first use ``install -d`` to create the |
1928 | directories under | 1928 | directories under |
1929 | ``${``\ :term:`D`\ ``}``. Once the | 1929 | ``${``\ :term:`D`\ ``}``. Once the |
@@ -1946,10 +1946,10 @@ installed correctly. | |||
1946 | might need to replace hard-coded paths in an initscript with | 1946 | might need to replace hard-coded paths in an initscript with |
1947 | values of variables provided by the build system, such as | 1947 | values of variables provided by the build system, such as |
1948 | replacing ``/usr/bin/`` with ``${bindir}``. If you do perform such | 1948 | replacing ``/usr/bin/`` with ``${bindir}``. If you do perform such |
1949 | modifications during ``do_install``, be sure to modify the | 1949 | modifications during :ref:`ref-tasks-install`, be sure to modify the |
1950 | destination file after copying rather than before copying. | 1950 | destination file after copying rather than before copying. |
1951 | Modifying after copying ensures that the build system can | 1951 | Modifying after copying ensures that the build system can |
1952 | re-execute ``do_install`` if needed. | 1952 | re-execute :ref:`ref-tasks-install` if needed. |
1953 | 1953 | ||
1954 | - ``oe_runmake install``, which can be run directly or can be run | 1954 | - ``oe_runmake install``, which can be run directly or can be run |
1955 | indirectly by the | 1955 | indirectly by the |
@@ -1958,7 +1958,7 @@ installed correctly. | |||
1958 | runs ``make install`` in parallel. Sometimes, a Makefile can have | 1958 | runs ``make install`` in parallel. Sometimes, a Makefile can have |
1959 | missing dependencies between targets that can result in race | 1959 | missing dependencies between targets that can result in race |
1960 | conditions. If you experience intermittent failures during | 1960 | conditions. If you experience intermittent failures during |
1961 | ``do_install``, you might be able to work around them by disabling | 1961 | :ref:`ref-tasks-install`, you might be able to work around them by disabling |
1962 | parallel Makefile installs by adding the following to the recipe:: | 1962 | parallel Makefile installs by adding the following to the recipe:: |
1963 | 1963 | ||
1964 | PARALLEL_MAKEINST = "" | 1964 | PARALLEL_MAKEINST = "" |
@@ -1980,7 +1980,7 @@ additional definitions in your recipe. | |||
1980 | If you are adding services and the service initialization script or the | 1980 | If you are adding services and the service initialization script or the |
1981 | service file itself is not installed, you must provide for that | 1981 | service file itself is not installed, you must provide for that |
1982 | installation in your recipe using a ``do_install:append`` function. If | 1982 | installation in your recipe using a ``do_install:append`` function. If |
1983 | your recipe already has a ``do_install`` function, update the function | 1983 | your recipe already has a :ref:`ref-tasks-install` function, update the function |
1984 | near its end rather than adding an additional ``do_install:append`` | 1984 | near its end rather than adding an additional ``do_install:append`` |
1985 | function. | 1985 | function. |
1986 | 1986 | ||
@@ -2337,7 +2337,7 @@ Single .c File Package (Hello World!) | |||
2337 | Building an application from a single file that is stored locally (e.g. | 2337 | Building an application from a single file that is stored locally (e.g. |
2338 | under ``files``) requires a recipe that has the file listed in the | 2338 | under ``files``) requires a recipe that has the file listed in the |
2339 | :term:`SRC_URI` variable. Additionally, you need to manually write the | 2339 | :term:`SRC_URI` variable. Additionally, you need to manually write the |
2340 | ``do_compile`` and ``do_install`` tasks. The :term:`S` variable defines the | 2340 | ``do_compile`` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the |
2341 | directory containing the source code, which is set to | 2341 | directory containing the source code, which is set to |
2342 | :term:`WORKDIR` in this case --- the | 2342 | :term:`WORKDIR` in this case --- the |
2343 | directory BitBake uses for the build. | 2343 | directory BitBake uses for the build. |
@@ -2407,8 +2407,8 @@ should store them in the | |||
2407 | :term:`EXTRA_OEMAKE` or | 2407 | :term:`EXTRA_OEMAKE` or |
2408 | :term:`PACKAGECONFIG_CONFARGS` | 2408 | :term:`PACKAGECONFIG_CONFARGS` |
2409 | variables. BitBake passes these options into the GNU ``make`` | 2409 | variables. BitBake passes these options into the GNU ``make`` |
2410 | invocation. Note that a ``do_install`` task is still required. | 2410 | invocation. Note that a :ref:`ref-tasks-install` task is still required. |
2411 | Otherwise, BitBake runs an empty ``do_install`` task by default. | 2411 | Otherwise, BitBake runs an empty :ref:`ref-tasks-install` task by default. |
2412 | 2412 | ||
2413 | Some applications might require extra parameters to be passed to the | 2413 | Some applications might require extra parameters to be passed to the |
2414 | compiler. For example, the application might need an additional header | 2414 | compiler. For example, the application might need an additional header |
@@ -2567,7 +2567,7 @@ doing the following: | |||
2567 | :ref:`ref-tasks-patch` tasks to the | 2567 | :ref:`ref-tasks-patch` tasks to the |
2568 | :ref:`ref-tasks-install` task. | 2568 | :ref:`ref-tasks-install` task. |
2569 | 2569 | ||
2570 | - Make sure your ``do_install`` task installs the binaries | 2570 | - Make sure your :ref:`ref-tasks-install` task installs the binaries |
2571 | appropriately. | 2571 | appropriately. |
2572 | 2572 | ||
2573 | - Ensure that you set up :term:`FILES` | 2573 | - Ensure that you set up :term:`FILES` |
@@ -4700,7 +4700,7 @@ the built library. | |||
4700 | The :term:`PACKAGES` and | 4700 | The :term:`PACKAGES` and |
4701 | :term:`FILES:* <FILES>` variables in the | 4701 | :term:`FILES:* <FILES>` variables in the |
4702 | ``meta/conf/bitbake.conf`` configuration file define how files installed | 4702 | ``meta/conf/bitbake.conf`` configuration file define how files installed |
4703 | by the ``do_install`` task are packaged. By default, the :term:`PACKAGES` | 4703 | by the :ref:`ref-tasks-install` task are packaged. By default, the :term:`PACKAGES` |
4704 | variable includes ``${PN}-staticdev``, which represents all static | 4704 | variable includes ``${PN}-staticdev``, which represents all static |
4705 | library files. | 4705 | library files. |
4706 | 4706 | ||
@@ -6862,7 +6862,7 @@ The previous example specifies a number of things in the call to | |||
6862 | ``do_split_packages``. | 6862 | ``do_split_packages``. |
6863 | 6863 | ||
6864 | - A directory within the files installed by your recipe through | 6864 | - A directory within the files installed by your recipe through |
6865 | ``do_install`` in which to search. | 6865 | :ref:`ref-tasks-install` in which to search. |
6866 | 6866 | ||
6867 | - A regular expression used to match module files in that directory. In | 6867 | - A regular expression used to match module files in that directory. In |
6868 | the example, note the parentheses () that mark the part of the | 6868 | the example, note the parentheses () that mark the part of the |
@@ -9594,7 +9594,7 @@ Running Specific Tasks | |||
9594 | 9594 | ||
9595 | Any given recipe consists of a set of tasks. The standard BitBake | 9595 | Any given recipe consists of a set of tasks. The standard BitBake |
9596 | behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, | 9596 | behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, |
9597 | ``do_configure``, ``do_compile``, ``do_install``, ``do_package``, | 9597 | ``do_configure``, ``do_compile``, :ref:`ref-tasks-install`, ``do_package``, |
9598 | ``do_package_write_*``, and ``do_build``. The default task is | 9598 | ``do_package_write_*``, and ``do_build``. The default task is |
9599 | ``do_build`` and any tasks on which it depends build first. Some tasks, | 9599 | ``do_build`` and any tasks on which it depends build first. Some tasks, |
9600 | such as ``do_devshell``, are not part of the default build chain. If you | 9600 | such as ``do_devshell``, are not part of the default build chain. If you |