summaryrefslogtreecommitdiffstats
path: root/documentation/test-manual/intro.rst
Commit message (Collapse)AuthorAgeFilesLines
* test-manual/intro: remove Buildbot version usedAntonin Godard2025-05-191-7/+5
| | | | | | | | | | | | | | The version has changed now (3.10.12 as of writing). Avoid having to maintain this information by removing the version info from the intro. Also fix a typo ("uses now uses") and give a link to yocto-autobuilder2. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a7000370ca9c1c623cd9272738f1a252e6556951) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ed64dbdf4a60b000305cdc2c67dc24f4bc97ef7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: move runtime-testing section to the test-manualAntonin Godard2025-01-091-1/+3
| | | | | | | | | | | | | | | In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 79aa34db34def525a11c41d951365bcb891318c4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/packages: move ptest section to the test-manualAntonin Godard2025-01-091-1/+1
| | | | | | | | | | | | | | | | [ YOCTO #15106 ] It makes more sense to document ptests in the test-manual. Since ptests are still related to packages, keep a link to ptests from packages.rst to the test-manual. Reported-by: Yoann Congal <yoann.congal@smile.fr> (From yocto-docs rev: 110e15c4407dfc03c7d931e4488eb43dbfad7570) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* test-manual: explicit or fix file pathsMichael Opdenacker2023-12-181-7/+5
| | | | | | | (From yocto-docs rev: e6fd1912bdbaeb1c8e29f5d7987ee24f9def1ab7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: add links to python unittestMichael Opdenacker2023-12-181-12/+16
| | | | | | | | | | Better than using "python unittest" without any special formatting. (From yocto-docs rev: ddf899611c56e6f44e9da2c69ed9c75a5491d882) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: use working exampleMichael Opdenacker2023-12-181-4/+4
| | | | | | | (From yocto-docs rev: 29dce8130e4de68a4690add673bca0eef17c8260) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: resource updatesMichael Opdenacker2023-12-181-11/+9
| | | | | | | (From yocto-docs rev: 230523f2b834d3fdb2114956678e3003a486cebc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: text and formatting fixesMichael Opdenacker2023-12-181-22/+22
| | | | | | | (From yocto-docs rev: 7c4f616f773bb9071b395e977b2ca9f8ac8f7e2a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to classesMichael Opdenacker2023-01-061-9/+9
| | | | | | | | | | | | | | | Now that .bbclass is removed from class section titles. We can now have, for example, :ref:`ref-classes-insane` instead of :ref:`insane <ref-classes-insane>`. Then, when necessary, rework paragraphs so that they have lines of even length, not exceeding 80 characters. (From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add missing references to variablesMichael Opdenacker2022-12-181-4/+4
| | | | | | | | [YOCTO #14508] (From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-1/+1
| | | | | | | | | | | | | | A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-071-2/+1
| | | | | | | (From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to testimage-auto classPaul Eggleton2022-10-191-2/+2
| | | | | | | | | testimage-auto was removed in the thud release. (From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace hyphens with em dashesMichael Opdenacker2022-06-271-2/+2
| | | | | | | | | | | | | | | | | | | Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual/intro: bitbake-selftest needs bitbakeZach Welch2022-05-281-0/+6
| | | | | | | | | | | | Without adding bitbake/bin to the PATH, some tests will fail when they cannot find the main bitbake script. (From yocto-docs rev: 1bbeb83bbff71a670ced81146732f04a947473b5) Signed-off-by: Zachary T Welch <zach@aquabyte.ai> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual/intro: reorder bitbake-selftest stepsZach Welch2022-05-281-5/+5
| | | | | | | | | | | | The addition of the verbose example interrupted the description of the BB_SKIP_NETTESTS option. (From yocto-docs rev: 9d94046bdb21671e9281ba725fa3aaf9299d3989) Signed-off-by: Zachary T Welch <zach@aquabyte.ai> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve the width of diagramsMichael Opdenacker2022-05-101-0/+1
| | | | | | | | | | | | Better for EPUB output in particular - Make some diagrams wider when necessary - Remove ":align: center" when we have ":width: 100%" - Update the standards.md files to mention this (From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix name capitalization issuesMichael Opdenacker2022-05-101-4/+4
| | | | | | | | | | | | - Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the title of the "BitBake User Manual". - Using "OpenEmbedded" instead of "Openembedded" - Using "Python" instead of "python" (From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: Correct two references to BB_SKIP_NETTESTSPeter Kjellerstedt2022-02-031-2/+2
| | | | | | | | | | | | The environment variable used to disable network tests when running bitbake-selftest was incorrectly referred to as BB_SKIP_NETTEST. (From yocto-docs rev: 4a2252cf412ea2aa26209d835c96661a772b6d31) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* misc manuals: add further class referencesMichael Opdenacker2021-12-131-1/+1
| | | | | | | (From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Spellcheck and capitalization fixesMichael Opdenacker2021-04-061-5/+5
| | | | | | | | | | | | | | | - Spelling fixes found using Emacs' spelling checker configured for US English - Fixes for some capitalization issues, especially some project names (QEMU, openSUSE, BusyBox), that were not consistently used with the same capitalization anyway. - A few whitespace fixes too (From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-3/+3
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove 'dev-manual' from filenamesNicolas Dechesne2020-12-091-1/+1
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: remove 'test-manual' from filenamesNicolas Dechesne2020-12-091-0/+528
All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 1b1f2fbd9283ba53c74ea4231ab4391627eb4187) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>