diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 13:37:11 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 28afbf81ecb34add93f5eed2c1a41ec5f278d0a7 (patch) | |
tree | 62804dd25f10e4a3781268549cde2aba8bafcb03 /documentation/dev-manual | |
parent | 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (diff) | |
download | poky-28afbf81ecb34add93f5eed2c1a41ec5f278d0a7.tar.gz |
sphinx: fix links when the link text should be displayed
When an hyperlink should be display in the output, there is no need to
any specific syntax or marker, the parser finds links and mail
addresses in ordinary text. Somehow the conversion from pandoc
generated wrong output in the form: ` <link>`__. This patch is
generated using the following Python regexp:
line = re.sub("` <(https?://.*)>`__",
"\\1",
line)
(From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.rst | 30 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.rst | 6 |
2 files changed, 18 insertions, 18 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index 0703f3ebc8..0807bd546f 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst | |||
@@ -294,7 +294,7 @@ Logo for your layer and application. The process consists of two parts: | |||
294 | successful compatibility registration. | 294 | successful compatibility registration. |
295 | 295 | ||
296 | 2. Completion of an application acceptance form, which you can find at | 296 | 2. Completion of an application acceptance form, which you can find at |
297 | ` <https://www.yoctoproject.org/webform/yocto-project-compatible-registration>`__. | 297 | https://www.yoctoproject.org/webform/yocto-project-compatible-registration. |
298 | 298 | ||
299 | To be granted permission to use the logo, you need to satisfy the | 299 | To be granted permission to use the logo, you need to satisfy the |
300 | following: | 300 | following: |
@@ -318,7 +318,7 @@ application, you can use the Yocto Project Compatibility Logo with your | |||
318 | layer and the application that uses your layer. | 318 | layer and the application that uses your layer. |
319 | 319 | ||
320 | To access the form, use this link: | 320 | To access the form, use this link: |
321 | ` <https://www.yoctoproject.org/webform/yocto-project-compatible-registration>`__. | 321 | https://www.yoctoproject.org/webform/yocto-project-compatible-registration. |
322 | Follow the instructions on the form to complete your application. | 322 | Follow the instructions on the form to complete your application. |
323 | 323 | ||
324 | The application consists of the following sections: | 324 | The application consists of the following sections: |
@@ -1713,7 +1713,7 @@ the software being built: | |||
1713 | install the built software into the directories. | 1713 | install the built software into the directories. |
1714 | 1714 | ||
1715 | You can find more information on ``install`` at | 1715 | You can find more information on ``install`` at |
1716 | ` <http://www.gnu.org/software/coreutils/manual/html_node/install-invocation.html>`__. | 1716 | http://www.gnu.org/software/coreutils/manual/html_node/install-invocation.html. |
1717 | 1717 | ||
1718 | For the scenarios that do not use Autotools or CMake, you need to track | 1718 | For the scenarios that do not use Autotools or CMake, you need to track |
1719 | the installation and diagnose and fix any issues until everything | 1719 | the installation and diagnose and fix any issues until everything |
@@ -1796,7 +1796,7 @@ different ways: | |||
1796 | - *systemd:* System Management Daemon (systemd) was designed to replace | 1796 | - *systemd:* System Management Daemon (systemd) was designed to replace |
1797 | SysVinit and to provide enhanced management of services. For more | 1797 | SysVinit and to provide enhanced management of services. For more |
1798 | information on systemd, see the systemd homepage at | 1798 | information on systemd, see the systemd homepage at |
1799 | ` <http://freedesktop.org/wiki/Software/systemd/>`__. | 1799 | http://freedesktop.org/wiki/Software/systemd/. |
1800 | 1800 | ||
1801 | To enable a service using systemd, your recipe needs to inherit the | 1801 | To enable a service using systemd, your recipe needs to inherit the |
1802 | :ref:`systemd <ref-classes-systemd>` class. See | 1802 | :ref:`systemd <ref-classes-systemd>` class. See |
@@ -1952,7 +1952,7 @@ recipe, but which one? You can configure your build to call out the | |||
1952 | kernel recipe you want by using the | 1952 | kernel recipe you want by using the |
1953 | :term:`PREFERRED_PROVIDER` | 1953 | :term:`PREFERRED_PROVIDER` |
1954 | variable. As an example, consider the | 1954 | variable. As an example, consider the |
1955 | ```x86-base.inc`` <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`__ | 1955 | ```x86-base.inc`https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc |
1956 | include file, which is a machine (i.e. | 1956 | include file, which is a machine (i.e. |
1957 | :term:`MACHINE`) configuration file. | 1957 | :term:`MACHINE`) configuration file. |
1958 | This include file is the reason all x86-based machines use the | 1958 | This include file is the reason all x86-based machines use the |
@@ -2806,7 +2806,7 @@ the layer tree. | |||
2806 | 2806 | ||
2807 | You can easily set up to run the AUH utility on a regular basis by using | 2807 | You can easily set up to run the AUH utility on a regular basis by using |
2808 | a cron job. See the | 2808 | a cron job. See the |
2809 | ```weeklyjob.sh`` <http://git.yoctoproject.org/cgit/cgit.cgi/auto-upgrade-helper/tree/weeklyjob.sh>`__ | 2809 | ```weeklyjob.sh`http://git.yoctoproject.org/cgit/cgit.cgi/auto-upgrade-helper/tree/weeklyjob.sh |
2810 | file distributed with the utility for an example. | 2810 | file distributed with the utility for an example. |
2811 | 2811 | ||
2812 | .. _gs-using-devtool-upgrade: | 2812 | .. _gs-using-devtool-upgrade: |
@@ -4764,7 +4764,7 @@ follows: | |||
4764 | A good example of an external toolchain used with the Yocto Project is | 4764 | A good example of an external toolchain used with the Yocto Project is |
4765 | Mentor Graphics Sourcery G++ Toolchain. You can see information on how | 4765 | Mentor Graphics Sourcery G++ Toolchain. You can see information on how |
4766 | to use that particular layer in the ``README`` file at | 4766 | to use that particular layer in the ``README`` file at |
4767 | ` <http://github.com/MentorEmbedded/meta-sourcery/>`__. You can find | 4767 | http://github.com/MentorEmbedded/meta-sourcery/. You can find |
4768 | further information by reading about the | 4768 | further information by reading about the |
4769 | :term:`TCMODE` variable in the Yocto | 4769 | :term:`TCMODE` variable in the Yocto |
4770 | Project Reference Manual's variable glossary. | 4770 | Project Reference Manual's variable glossary. |
@@ -5583,7 +5583,7 @@ system to make your images more secure: | |||
5583 | - Consider enabling a Mandatory Access Control (MAC) framework such as | 5583 | - Consider enabling a Mandatory Access Control (MAC) framework such as |
5584 | SMACK or SELinux and tuning it appropriately for your device's usage. | 5584 | SMACK or SELinux and tuning it appropriately for your device's usage. |
5585 | You can find more information in the | 5585 | You can find more information in the |
5586 | ```meta-selinux`` <http://git.yoctoproject.org/cgit/cgit.cgi/meta-selinux/>`__ | 5586 | ```meta-selinux`http://git.yoctoproject.org/cgit/cgit.cgi/meta-selinux/ |
5587 | layer. | 5587 | layer. |
5588 | 5588 | ||
5589 | Tools for Hardening Your Image | 5589 | Tools for Hardening Your Image |
@@ -6690,7 +6690,7 @@ NPM packages: | |||
6690 | packages, the registry approach is slightly simpler. However, you | 6690 | packages, the registry approach is slightly simpler. However, you |
6691 | might consider the project approach because you do not have to | 6691 | might consider the project approach because you do not have to |
6692 | publish your module in the NPM registry | 6692 | publish your module in the NPM registry |
6693 | (```npm-registry`` <https://docs.npmjs.com/misc/registry>`__), which | 6693 | (```npm-registry`https://docs.npmjs.com/misc/registry), which |
6694 | is NPM's public registry. | 6694 | is NPM's public registry. |
6695 | 6695 | ||
6696 | - Be familiar with | 6696 | - Be familiar with |
@@ -6698,7 +6698,7 @@ NPM packages: | |||
6698 | 6698 | ||
6699 | - The NPM host tools need the native ``nodejs-npm`` package, which is | 6699 | - The NPM host tools need the native ``nodejs-npm`` package, which is |
6700 | part of the OpenEmbedded environment. You need to get the package by | 6700 | part of the OpenEmbedded environment. You need to get the package by |
6701 | cloning the ` <https://github.com/openembedded/meta-openembedded>`__ | 6701 | cloning the https://github.com/openembedded/meta-openembedded |
6702 | repository out of GitHub. Be sure to add the path to your local copy | 6702 | repository out of GitHub. Be sure to add the path to your local copy |
6703 | to your ``bblayers.conf`` file. | 6703 | to your ``bblayers.conf`` file. |
6704 | 6704 | ||
@@ -7547,7 +7547,7 @@ packages/qemux86_64-poky-linux/v86d/v86d: PKGSIZE changed from 110579 to | |||
7547 | 7547 | ||
7548 | To see changes to the build history using a web interface, follow the | 7548 | To see changes to the build history using a web interface, follow the |
7549 | instruction in the ``README`` file here. | 7549 | instruction in the ``README`` file here. |
7550 | ` <http://git.yoctoproject.org/cgit/cgit.cgi/buildhistory-web/>`__. | 7550 | http://git.yoctoproject.org/cgit/cgit.cgi/buildhistory-web/. |
7551 | 7551 | ||
7552 | Here is a sample screenshot of the interface: | 7552 | Here is a sample screenshot of the interface: |
7553 | 7553 | ||
@@ -8945,7 +8945,7 @@ style analysis of program crashes. GDB is available as a package within | |||
8945 | the Yocto Project and is installed in SDK images by default. See the | 8945 | the Yocto Project and is installed in SDK images by default. See the |
8946 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto | 8946 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto |
8947 | Project Reference Manual for a description of these images. You can find | 8947 | Project Reference Manual for a description of these images. You can find |
8948 | information on GDB at ` <http://sourceware.org/gdb/>`__. | 8948 | information on GDB at http://sourceware.org/gdb/. |
8949 | 8949 | ||
8950 | .. note:: | 8950 | .. note:: |
8951 | 8951 | ||
@@ -10086,7 +10086,7 @@ The server receives the information collected and saves it in a | |||
10086 | database. | 10086 | database. |
10087 | 10087 | ||
10088 | A live instance of the error reporting server exists at | 10088 | A live instance of the error reporting server exists at |
10089 | ` <http://errors.yoctoproject.org>`__. This server exists so that when | 10089 | http://errors.yoctoproject.org. This server exists so that when |
10090 | you want to get help with build failures, you can submit all of the | 10090 | you want to get help with build failures, you can submit all of the |
10091 | information on the failure easily and then point to the URL in your bug | 10091 | information on the failure easily and then point to the URL in your bug |
10092 | report or send an email to the mailing list. | 10092 | report or send an email to the mailing list. |
@@ -10119,7 +10119,7 @@ following command sends the errors to an upstream server: $ | |||
10119 | send-error-report | 10119 | send-error-report |
10120 | /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt | 10120 | /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt |
10121 | In the previous example, the errors are sent to a public database | 10121 | In the previous example, the errors are sent to a public database |
10122 | available at ` <http://errors.yoctoproject.org>`__, which is used by the | 10122 | available at http://errors.yoctoproject.org, which is used by the |
10123 | entire community. If you specify a particular server, you can send the | 10123 | entire community. If you specify a particular server, you can send the |
10124 | errors to a different database. Use the following command for more | 10124 | errors to a different database. Use the following command for more |
10125 | information on available options: $ send-error-report --help | 10125 | information on available options: $ send-error-report --help |
@@ -10145,7 +10145,7 @@ Setting Up Your Own Error Reporting Server | |||
10145 | 10145 | ||
10146 | If you want to set up your own error reporting server, you can obtain | 10146 | If you want to set up your own error reporting server, you can obtain |
10147 | the code from the Git repository at | 10147 | the code from the Git repository at |
10148 | ` <http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/>`__. | 10148 | http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/. |
10149 | Instructions on how to set it up are in the README document. | 10149 | Instructions on how to set it up are in the README document. |
10150 | 10150 | ||
10151 | .. _dev-using-wayland-and-weston: | 10151 | .. _dev-using-wayland-and-weston: |
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst index 884d1286ef..b935f7b63e 100644 --- a/documentation/dev-manual/dev-manual-start.rst +++ b/documentation/dev-manual/dev-manual-start.rst | |||
@@ -445,14 +445,14 @@ as your Yocto Project build host: | |||
445 | 445 | ||
446 | 5. *Optionally Orient Yourself With Docker:* If you are unfamiliar with | 446 | 5. *Optionally Orient Yourself With Docker:* If you are unfamiliar with |
447 | Docker and the container concept, you can learn more here - | 447 | Docker and the container concept, you can learn more here - |
448 | ` <https://docs.docker.com/get-started/>`__. | 448 | https://docs.docker.com/get-started/. |
449 | 449 | ||
450 | 6. *Launch Docker or Docker Toolbox:* You should be able to launch | 450 | 6. *Launch Docker or Docker Toolbox:* You should be able to launch |
451 | Docker or the Docker Toolbox and have a terminal shell on your | 451 | Docker or the Docker Toolbox and have a terminal shell on your |
452 | development host. | 452 | development host. |
453 | 453 | ||
454 | 7. *Set Up the Containers to Use the Yocto Project:* Go to | 454 | 7. *Set Up the Containers to Use the Yocto Project:* Go to |
455 | ` <https://github.com/crops/docker-win-mac-docs/wiki>`__ and follow | 455 | https://github.com/crops/docker-win-mac-docs/wiki and follow |
456 | the directions for your particular build host (i.e. Linux, Mac, or | 456 | the directions for your particular build host (i.e. Linux, Mac, or |
457 | Windows). | 457 | Windows). |
458 | 458 | ||
@@ -514,7 +514,7 @@ your Yocto Project build host: | |||
514 | 514 | ||
515 | 4. *Optionally Orient Yourself on WSL:* If you are unfamiliar with WSL, | 515 | 4. *Optionally Orient Yourself on WSL:* If you are unfamiliar with WSL, |
516 | you can learn more here - | 516 | you can learn more here - |
517 | ` <https://docs.microsoft.com/en-us/windows/wsl/wsl2-about>`__. | 517 | https://docs.microsoft.com/en-us/windows/wsl/wsl2-about. |
518 | 518 | ||
519 | 5. *Launch your WSL Distibution:* From the Windows start menu simply | 519 | 5. *Launch your WSL Distibution:* From the Windows start menu simply |
520 | launch your WSL distribution just like any other application. | 520 | launch your WSL distribution just like any other application. |