diff options
| author | Quentin Schulz <foss@0leil.net> | 2020-09-17 01:58:59 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:36 +0100 |
| commit | c387f0c2543a9dd7f8eca069629ede4bb5ec5dba (patch) | |
| tree | d0a7fccf9b84915862b1174ae75cd0437a60bb2d /documentation/test-manual | |
| parent | 6813141743f4263e6b03fd7294f9cec4ec1a3194 (diff) | |
| download | poky-c387f0c2543a9dd7f8eca069629ede4bb5ec5dba.tar.gz | |
sphinx: replace special quotes with single and double quotes
(From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/test-manual')
4 files changed, 24 insertions, 24 deletions
diff --git a/documentation/test-manual/test-manual-intro.rst b/documentation/test-manual/test-manual-intro.rst index b0bc24c9b0..53ad650b35 100644 --- a/documentation/test-manual/test-manual-intro.rst +++ b/documentation/test-manual/test-manual-intro.rst | |||
| @@ -12,9 +12,9 @@ Welcome | |||
| 12 | Welcome to the Yocto Project Test Environment Manual! This manual is a | 12 | Welcome to the Yocto Project Test Environment Manual! This manual is a |
| 13 | work in progress. The manual contains information about the testing | 13 | work in progress. The manual contains information about the testing |
| 14 | environment used by the Yocto Project to make sure each major and minor | 14 | environment used by the Yocto Project to make sure each major and minor |
| 15 | release works as intended. All the project’s testing infrastructure and | 15 | release works as intended. All the project's testing infrastructure and |
| 16 | processes are publicly visible and available so that the community can | 16 | processes are publicly visible and available so that the community can |
| 17 | see what testing is being performed, how it’s being done and the current | 17 | see what testing is being performed, how it's being done and the current |
| 18 | status of the tests and the project at any given time. It is intended | 18 | status of the tests and the project at any given time. It is intended |
| 19 | that Other organizations can leverage off the process and testing | 19 | that Other organizations can leverage off the process and testing |
| 20 | environment used by the Yocto Project to create their own automated, | 20 | environment used by the Yocto Project to create their own automated, |
| @@ -514,7 +514,7 @@ resource utilisation as that happens. An example from | |||
| 514 | 'bitbake -p (cached)') | 514 | 'bitbake -p (cached)') |
| 515 | 515 | ||
| 516 | This example shows how three specific parsing timings are | 516 | This example shows how three specific parsing timings are |
| 517 | measured, with and without various caches, to show how BitBake’s parsing | 517 | measured, with and without various caches, to show how BitBake's parsing |
| 518 | performance trends over time. | 518 | performance trends over time. |
| 519 | 519 | ||
| 520 | .. _test-writing-considerations: | 520 | .. _test-writing-considerations: |
diff --git a/documentation/test-manual/test-manual-intro.xml b/documentation/test-manual/test-manual-intro.xml index 8e2c7cd874..0cdbee4d8e 100644 --- a/documentation/test-manual/test-manual-intro.xml +++ b/documentation/test-manual/test-manual-intro.xml | |||
| @@ -12,8 +12,8 @@ | |||
| 12 | <para> Welcome to the Yocto Project Test Environment Manual! This manual is a work in | 12 | <para> Welcome to the Yocto Project Test Environment Manual! This manual is a work in |
| 13 | progress. The manual contains information about the testing environment used by the | 13 | progress. The manual contains information about the testing environment used by the |
| 14 | Yocto Project to make sure each major and minor release works as intended. All the | 14 | Yocto Project to make sure each major and minor release works as intended. All the |
| 15 | project’s testing infrastructure and processes are publicly visible and available so | 15 | project's testing infrastructure and processes are publicly visible and available so |
| 16 | that the community can see what testing is being performed, how it’s being done and the | 16 | that the community can see what testing is being performed, how it's being done and the |
| 17 | current status of the tests and the project at any given time. It is intended that Other | 17 | current status of the tests and the project at any given time. It is intended that Other |
| 18 | organizations can leverage off the process and testing environment used by the Yocto | 18 | organizations can leverage off the process and testing environment used by the Yocto |
| 19 | Project to create their own automated, production test environment, building upon the | 19 | Project to create their own automated, production test environment, building upon the |
| @@ -579,7 +579,7 @@ | |||
| 579 | 'bitbake -p (cached)') | 579 | 'bitbake -p (cached)') |
| 580 | </literallayout>This | 580 | </literallayout>This |
| 581 | example shows how three specific parsing timings are measured, with and without | 581 | example shows how three specific parsing timings are measured, with and without |
| 582 | various caches, to show how BitBake’s parsing performance trends over time.</para> | 582 | various caches, to show how BitBake's parsing performance trends over time.</para> |
| 583 | </section> | 583 | </section> |
| 584 | </section> | 584 | </section> |
| 585 | <section id='test-writing-considerations'> | 585 | <section id='test-writing-considerations'> |
diff --git a/documentation/test-manual/test-manual-understand-autobuilder.rst b/documentation/test-manual/test-manual-understand-autobuilder.rst index 0809190b5b..2fcae5000e 100644 --- a/documentation/test-manual/test-manual-understand-autobuilder.rst +++ b/documentation/test-manual/test-manual-understand-autobuilder.rst | |||
| @@ -7,19 +7,19 @@ Understanding the Yocto Project Autobuilder | |||
| 7 | Execution Flow within the Autobuilder | 7 | Execution Flow within the Autobuilder |
| 8 | ===================================== | 8 | ===================================== |
| 9 | 9 | ||
| 10 | The “a-full” and “a-quick” targets are the usual entry points into the | 10 | The "a-full" and "a-quick" targets are the usual entry points into the |
| 11 | Autobuilder and it makes sense to follow the process through the system | 11 | Autobuilder and it makes sense to follow the process through the system |
| 12 | starting there. This is best visualised from the Autobuilder Console | 12 | starting there. This is best visualised from the Autobuilder Console |
| 13 | view (:yocto_ab:`/typhoon/#/console`). | 13 | view (:yocto_ab:`/typhoon/#/console`). |
| 14 | 14 | ||
| 15 | Each item along the top of that view represents some “target build” and | 15 | Each item along the top of that view represents some "target build" and |
| 16 | these targets are all run in parallel. The ‘full’ build will trigger the | 16 | these targets are all run in parallel. The 'full' build will trigger the |
| 17 | majority of them, the “quick” build will trigger some subset of them. | 17 | majority of them, the "quick" build will trigger some subset of them. |
| 18 | The Autobuilder effectively runs whichever configuration is defined for | 18 | The Autobuilder effectively runs whichever configuration is defined for |
| 19 | each of those targets on a seperate buildbot worker. To understand the | 19 | each of those targets on a seperate buildbot worker. To understand the |
| 20 | configuration, you need to look at the entry on ``config.json`` file | 20 | configuration, you need to look at the entry on ``config.json`` file |
| 21 | within the ``yocto-autobuilder-helper`` repository. The targets are | 21 | within the ``yocto-autobuilder-helper`` repository. The targets are |
| 22 | defined in the ‘overrides’ section, a quick example could be qemux86-64 | 22 | defined in the ‘overrides' section, a quick example could be qemux86-64 |
| 23 | which looks like:: | 23 | which looks like:: |
| 24 | 24 | ||
| 25 | "qemux86-64" : { | 25 | "qemux86-64" : { |
| @@ -32,8 +32,8 @@ which looks like:: | |||
| 32 | } | 32 | } |
| 33 | }, | 33 | }, |
| 34 | 34 | ||
| 35 | And to expand that, you need the “arch-qemu” entry from | 35 | And to expand that, you need the "arch-qemu" entry from |
| 36 | the “templates” section, which looks like:: | 36 | the "templates" section, which looks like:: |
| 37 | 37 | ||
| 38 | "arch-qemu" : { | 38 | "arch-qemu" : { |
| 39 | "BUILDINFO" : true, | 39 | "BUILDINFO" : true, |
| @@ -54,9 +54,9 @@ the “templates” section, which looks like:: | |||
| 54 | } | 54 | } |
| 55 | }, | 55 | }, |
| 56 | 56 | ||
| 57 | Combining these two entries you can see that “qemux86-64” is a three step build where the | 57 | Combining these two entries you can see that "qemux86-64" is a three step build where the |
| 58 | ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` for each step; all for | 58 | ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` for each step; all for |
| 59 | ``MACHINE=”qemx86-64”`` but with differing SDKMACHINE settings. In step | 59 | ``MACHINE="qemx86-64"`` but with differing SDKMACHINE settings. In step |
| 60 | 1 an extra variable is added to the ``auto.conf`` file to enable wic | 60 | 1 an extra variable is added to the ``auto.conf`` file to enable wic |
| 61 | image generation. | 61 | image generation. |
| 62 | 62 | ||
| @@ -262,7 +262,7 @@ of post-build steps, including: | |||
| 262 | 262 | ||
| 263 | #. Cleanup the build directory using | 263 | #. Cleanup the build directory using |
| 264 | :ref:`test-manual/test-manual-understand-autobuilder:clobberdir` if the build was successful, | 264 | :ref:`test-manual/test-manual-understand-autobuilder:clobberdir` if the build was successful, |
| 265 | else rename it to “build-renamed” for potential future debugging. | 265 | else rename it to "build-renamed" for potential future debugging. |
| 266 | 266 | ||
| 267 | .. _test-deploying-yp-autobuilder: | 267 | .. _test-deploying-yp-autobuilder: |
| 268 | 268 | ||
diff --git a/documentation/test-manual/test-manual-understand-autobuilder.xml b/documentation/test-manual/test-manual-understand-autobuilder.xml index a04006605f..8600367be7 100644 --- a/documentation/test-manual/test-manual-understand-autobuilder.xml +++ b/documentation/test-manual/test-manual-understand-autobuilder.xml | |||
| @@ -8,18 +8,18 @@ | |||
| 8 | <title>Understanding the Yocto Project Autobuilder</title> | 8 | <title>Understanding the Yocto Project Autobuilder</title> |
| 9 | <section> | 9 | <section> |
| 10 | <title>Execution Flow within the Autobuilder</title> | 10 | <title>Execution Flow within the Autobuilder</title> |
| 11 | <para>The “a-full” and “a-quick” targets are the usual entry points into the Autobuilder and | 11 | <para>The "a-full" and "a-quick" targets are the usual entry points into the Autobuilder and |
| 12 | it makes sense to follow the process through the system starting there. This is best | 12 | it makes sense to follow the process through the system starting there. This is best |
| 13 | visualised from the Autobuilder Console view (<link linkend="" | 13 | visualised from the Autobuilder Console view (<link linkend="" |
| 14 | >https://autobuilder.yoctoproject.org/typhoon/#/console</link>). </para> | 14 | >https://autobuilder.yoctoproject.org/typhoon/#/console</link>). </para> |
| 15 | <para>Each item along the top of that view represents some “target build” and these targets | 15 | <para>Each item along the top of that view represents some "target build" and these targets |
| 16 | are all run in parallel. The ‘full’ build will trigger the majority of them, the “quick” | 16 | are all run in parallel. The 'full' build will trigger the majority of them, the "quick" |
| 17 | build will trigger some subset of them. The Autobuilder effectively runs whichever | 17 | build will trigger some subset of them. The Autobuilder effectively runs whichever |
| 18 | configuration is defined for each of those targets on a seperate buildbot worker. To | 18 | configuration is defined for each of those targets on a seperate buildbot worker. To |
| 19 | understand the configuration, you need to look at the entry on | 19 | understand the configuration, you need to look at the entry on |
| 20 | <filename>config.json</filename> file within the | 20 | <filename>config.json</filename> file within the |
| 21 | <filename>yocto-autobuilder-helper</filename> repository. The targets are defined in | 21 | <filename>yocto-autobuilder-helper</filename> repository. The targets are defined in |
| 22 | the ‘overrides’ section, a quick example could be qemux86-64 which looks | 22 | the ‘overrides' section, a quick example could be qemux86-64 which looks |
| 23 | like:<literallayout class="monospaced"> | 23 | like:<literallayout class="monospaced"> |
| 24 | "qemux86-64" : { | 24 | "qemux86-64" : { |
| 25 | "MACHINE" : "qemux86-64", | 25 | "MACHINE" : "qemux86-64", |
| @@ -31,7 +31,7 @@ | |||
| 31 | } | 31 | } |
| 32 | }, | 32 | }, |
| 33 | </literallayout>And | 33 | </literallayout>And |
| 34 | to expand that, you need the “arch-qemu” entry from the “templates” section, which looks | 34 | to expand that, you need the "arch-qemu" entry from the "templates" section, which looks |
| 35 | like:<literallayout class="monospaced"> | 35 | like:<literallayout class="monospaced"> |
| 36 | "arch-qemu" : { | 36 | "arch-qemu" : { |
| 37 | "BUILDINFO" : true, | 37 | "BUILDINFO" : true, |
| @@ -52,10 +52,10 @@ | |||
| 52 | } | 52 | } |
| 53 | }, | 53 | }, |
| 54 | </literallayout>Combining | 54 | </literallayout>Combining |
| 55 | these two entries you can see that “qemux86-64” is a three step build where the | 55 | these two entries you can see that "qemux86-64" is a three step build where the |
| 56 | <filename>bitbake BBTARGETS</filename> would be run, then <filename>bitbake | 56 | <filename>bitbake BBTARGETS</filename> would be run, then <filename>bitbake |
| 57 | SANITYTARGETS</filename> for each step; all for | 57 | SANITYTARGETS</filename> for each step; all for |
| 58 | <filename>MACHINE=”qemx86-64”</filename> but with differing SDKMACHINE settings. In | 58 | <filename>MACHINE="qemx86-64"</filename> but with differing SDKMACHINE settings. In |
| 59 | step 1 an extra variable is added to the <filename>auto.conf</filename> file to enable | 59 | step 1 an extra variable is added to the <filename>auto.conf</filename> file to enable |
| 60 | wic image generation.</para> | 60 | wic image generation.</para> |
| 61 | <para>While not every detail of this is covered here, you can see how the templating | 61 | <para>While not every detail of this is covered here, you can see how the templating |
| @@ -260,7 +260,7 @@ | |||
| 260 | <listitem> | 260 | <listitem> |
| 261 | <para dir="ltr">Cleanup the build directory using <link | 261 | <para dir="ltr">Cleanup the build directory using <link |
| 262 | linkend="test-clobberdir"><filename>clobberdir</filename></link> if the | 262 | linkend="test-clobberdir"><filename>clobberdir</filename></link> if the |
| 263 | build was successful, else rename it to “build-renamed” for potential future | 263 | build was successful, else rename it to "build-renamed" for potential future |
| 264 | debugging.</para> | 264 | debugging.</para> |
| 265 | </listitem> | 265 | </listitem> |
| 266 | </orderedlist></para> | 266 | </orderedlist></para> |
