diff options
Diffstat (limited to 'documentation/overview-manual')
3 files changed, 31 insertions, 31 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index bbf2d0494e..d2e335e802 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst @@ -34,7 +34,7 @@ itself is of various types: BitBake knows how to combine multiple data sources together and refers to each data source as a layer. For information on layers, see the -":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" +":ref:`dev-manual/common-tasks:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. Following are some brief details on these core components. For @@ -153,7 +153,7 @@ Conforming to a known structure allows BitBake to make assumptions during builds on where to find types of metadata. You can find procedures and learn about tools (i.e. ``bitbake-layers``) for creating layers suitable for the Yocto Project in the -":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" +":ref:`dev-manual/common-tasks:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. OpenEmbedded Build System Concepts @@ -317,7 +317,7 @@ during the build. By default, the layers listed in this file include layers minimally needed by the build system. However, you must manually add any custom layers you have created. You can find more information on working with the ``bblayers.conf`` file in the -":ref:`dev-manual/dev-manual-common-tasks:enabling your layer`" +":ref:`dev-manual/common-tasks:enabling your layer`" section in the Yocto Project Development Tasks Manual. The files ``site.conf`` and ``auto.conf`` are not created by the @@ -418,7 +418,7 @@ a ``README`` file as good practice and especially if the layer is to be distributed, a configuration directory, and recipe directories. You can learn about the general structure for layers used with the Yocto Project in the -":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" +":ref:`dev-manual/common-tasks:creating your own layer`" section in the Yocto Project Development Tasks Manual. For a general discussion on layers and the many layers from which you can draw, see the @@ -827,7 +827,7 @@ For more information on how the source directories are created, see the "`Source Fetching <#source-fetching-dev-environment>`__" section. For more information on how to create patches and how the build system processes patches, see the -":ref:`dev-manual/dev-manual-common-tasks:patching code`" +":ref:`dev-manual/common-tasks:patching code`" section in the Yocto Project Development Tasks Manual. You can also see the ":ref:`sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" @@ -1029,7 +1029,7 @@ stage of package installation, post installation scripts that are part of the packages are run. Any scripts that fail to run on the build host are run on the target when the target system is first booted. If you are using a -:ref:`read-only root filesystem <dev-manual/dev-manual-common-tasks:creating a read-only root filesystem>`, +:ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`, all the post installation scripts must succeed on the build host during the package installation phase since the root filesystem on the target is read-only. @@ -1192,7 +1192,7 @@ varflag. If some other task depends on such a task, then that task will also always be considered out of date, which might not be what you want. For details on how to view information about a task's signature, see the -":ref:`dev-manual/dev-manual-common-tasks:viewing task variable dependencies`" +":ref:`dev-manual/common-tasks:viewing task variable dependencies`" section in the Yocto Project Development Tasks Manual. Setscene Tasks and Shared State @@ -1626,15 +1626,15 @@ them if they are deemed to be valid. the shared state packages. Consequently, considerations exist that affect maintaining shared state feeds. For information on how the build system works with packages and can track incrementing ``PR`` - information, see the ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" + information, see the ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" section in the Yocto Project Development Tasks Manual. - The code in the build system that supports incremental builds is not simple code. For techniques that help you work around issues related to shared state code, see the - ":ref:`dev-manual/dev-manual-common-tasks:viewing metadata used to create the input signature of a shared state task`" + ":ref:`dev-manual/common-tasks:viewing metadata used to create the input signature of a shared state task`" and - ":ref:`dev-manual/dev-manual-common-tasks:invalidating shared state to force a task to run`" + ":ref:`dev-manual/common-tasks:invalidating shared state to force a task to run`" sections both in the Yocto Project Development Tasks Manual. The rest of this section goes into detail about the overall incremental diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst index 2421ec1a85..e03b4cdc62 100644 --- a/documentation/overview-manual/overview-manual-development-environment.rst +++ b/documentation/overview-manual/overview-manual-development-environment.rst @@ -66,7 +66,7 @@ to set up a CROPS machine, you effectively have access to a shell environment that is similar to what you see when using a Linux-based development host. For the steps needed to set up a system using CROPS, see the -":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`" +":ref:`dev-manual/start:setting up to use cross platforms (crops)`" section in the Yocto Project Development Tasks Manual. @@ -77,7 +77,7 @@ distribution on the system is one that supports the Yocto Project. You also need to be sure that the correct set of host packages are installed that allow development using the Yocto Project. For the steps needed to set up a development host that runs Linux, see the -":ref:`dev-manual/dev-manual-start:setting up a native linux host`" +":ref:`dev-manual/start:setting up a native linux host`" section in the Yocto Project Development Tasks Manual. Once your development host is set up to use the Yocto Project, several @@ -94,7 +94,7 @@ methods exist for you to do work in the Yocto Project environment: through your Linux distribution and the Yocto Project. For a general flow of the build procedures, see the - ":ref:`dev-manual/dev-manual-common-tasks:building a simple image`" + ":ref:`dev-manual/common-tasks:building a simple image`" section in the Yocto Project Development Tasks Manual. - *Board Support Package (BSP) Development:* Development of BSPs @@ -178,7 +178,7 @@ development: :align: center For steps on how to view and access these upstream Git repositories, - see the ":ref:`dev-manual/dev-manual-start:accessing source repositories`" + see the ":ref:`dev-manual/start:accessing source repositories`" Section in the Yocto Project Development Tasks Manual. - :yocto_dl:`Index of /releases: </releases>` This is an index @@ -192,7 +192,7 @@ development: :align: center For steps on how to view and access these files, see the - ":ref:`dev-manual/dev-manual-start:accessing index of releases`" + ":ref:`dev-manual/start:accessing index of releases`" section in the Yocto Project Development Tasks Manual. - *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* @@ -207,7 +207,7 @@ development: :align: center For steps on how to use the "DOWNLOADS" page, see the - ":ref:`dev-manual/dev-manual-start:using the downloads page`" + ":ref:`dev-manual/start:using the downloads page`" section in the Yocto Project Development Tasks Manual. Git Workflows and the Yocto Project @@ -242,7 +242,7 @@ and so forth. For information on finding out who is responsible for (maintains) a particular area of code in the Yocto Project, see the - ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" + ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section of the Yocto Project Development Tasks Manual. The Yocto Project ``poky`` Git repository also has an upstream @@ -274,7 +274,7 @@ push them into the "contrib" area and subsequently request that the maintainer include them into an upstream branch. This process is called "submitting a patch" or "submitting a change." For information on submitting patches and changes, see the -":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" +":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the Yocto Project Development Tasks Manual. In summary, a single point of entry exists for changes into a "master" @@ -341,7 +341,7 @@ Book <http://book.git-scm.com>`__. the ``scripts`` folder of the :term:`Source Directory`. For information on how to use these scripts, see the - ":ref:`dev-manual/dev-manual-common-tasks:using scripts to push a change upstream and request a pull`" + ":ref:`dev-manual/common-tasks:using scripts to push a change upstream and request a pull`" section in the Yocto Project Development Tasks Manual. - *Patch Workflow:* This workflow allows you to notify the maintainer @@ -350,7 +350,7 @@ Book <http://book.git-scm.com>`__. this type of change, you format the patch and then send the email using the Git commands ``git format-patch`` and ``git send-email``. For information on how to use these scripts, see the - ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" + ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the Yocto Project Development Tasks Manual. Git @@ -376,7 +376,7 @@ commands. page, see http://git-scm.com/download. - For information beyond the introductory nature in this section, - see the ":ref:`dev-manual/dev-manual-start:locating yocto project source files`" + see the ":ref:`dev-manual/start:locating yocto project source files`" section in the Yocto Project Development Tasks Manual. Repositories, Tags, and Branches @@ -408,7 +408,7 @@ You can create a local copy of any repository by "cloning" it with the an identical copy of the repository on your development system. Once you have a local copy of a repository, you can take steps to develop locally. For examples on how to clone Git repositories, see the -":ref:`dev-manual/dev-manual-start:locating yocto project source files`" +":ref:`dev-manual/start:locating yocto project source files`" section in the Yocto Project Development Tasks Manual. It is important to understand that Git tracks content change and not @@ -661,5 +661,5 @@ Project uses in the ``meta/files/common-licenses`` directory in your For information that can help you maintain compliance with various open source licensing during the lifecycle of a product created using the Yocto Project, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index d6488c6211..a6568d1c8e 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/overview-manual-yp-intro.rst @@ -130,7 +130,7 @@ Project: arbitrarily include packages. - *License Manifest:* The Yocto Project provides a :ref:`license - manifest <dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle>` + manifest <dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle>` for review by people who need to track the use of open source licenses (e.g. legal teams). @@ -228,7 +228,7 @@ your Metadata, the easier it is to cope with future changes. - Layers support the inclusion of technologies, hardware components, and software components. The :ref:`Yocto Project - Compatible <dev-manual/dev-manual-common-tasks:making sure your layer is compatible with yocto project>` + Compatible <dev-manual/common-tasks:making sure your layer is compatible with yocto project>` designation provides a minimum level of standardization that contributes to a strong ecosystem. "YP Compatible" is applied to appropriate products and software components such as BSPs, other @@ -274,7 +274,7 @@ of the ``poky`` repository, you will see several layers: ``meta``, layer. For procedures on how to create layers, see the -":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" +":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. Components and Tools @@ -357,7 +357,7 @@ activities using the Yocto Project: (BitBake and OE-Core) automatically generates upgrades for recipes that are based on new versions of the recipes published upstream. See - :ref:`dev-manual/dev-manual-common-tasks:using the auto upgrade helper (auh)` + :ref:`dev-manual/common-tasks:using the auto upgrade helper (auh)` for how to set it up. - *Recipe Reporting System:* The Recipe Reporting System tracks recipe @@ -601,7 +601,7 @@ Project. For information on how to set up a Build Host on a system running Linux as its native operating system, see the - ":ref:`dev-manual/dev-manual-start:setting up a native linux host`" + ":ref:`dev-manual/start:setting up a native linux host`" section in the Yocto Project Development Tasks Manual. - *CROss PlatformS (CROPS):* Typically, you use @@ -621,7 +621,7 @@ Project. system natively running Linux. For information on how to set up a Build Host with CROPS, see the - ":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`" + ":ref:`dev-manual/start:setting up to use cross platforms (crops)`" section in the Yocto Project Development Tasks Manual. - *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem @@ -638,7 +638,7 @@ Project. virtualization technology. For information on how to set up a Build Host with WSLv2, see the - ":ref:`dev-manual/dev-manual-start:setting up to use windows subsystem for linux (wslv2)`" + ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`" section in the Yocto Project Development Tasks Manual. - *Toaster:* Regardless of what your Build Host is running, you can use @@ -824,7 +824,7 @@ helpful for getting started: Project. For more detailed information on layers, see the - ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" + ":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. For a discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto |