summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/tasks.rst
Commit message (Collapse)AuthorAgeFilesLines
* manuals: simplify references to class sectionsMichael Opdenacker2022-01-171-1/+1
| | | | | | | | | | | | | | | Replace ":ref:`classname.bbclass <ref-classes-classname>`" section by ":ref:`ref-classes-classname`" section because each section has "classname.bbclass" as title, therefore the result is the same. (From yocto-docs rev: e3f438e4a71b155bd09bc7988c8e5626a063fde3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix patch documentationMax Krummenacher2022-01-071-9/+7
| | | | | | | | | | | | | The do_patch implementation does not apply patches from an entry in SRC_URI pointing to a directory. Remove the claim that this is implemented. (From yocto-docs rev: de1156b6d95a2d1738807f0b0525edd0b58fc0e9) Signed-off-by: Max Krummenacher <max.krummenacher@toradex.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add more class referencesMichael Opdenacker2021-12-131-2/+2
| | | | | | | (From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: rename "devpyshell" to "pydevshell"Michael Opdenacker2021-10-201-4/+4
| | | | | | | | | | This addresses [YOCTO #14531] after the "devpyshell" task was renamed to "pydevshell" in OE core. (From yocto-docs rev: 1056320e90545c8dff0fc71a5fde752295d4d6e4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove checkpkg taskMichael Opdenacker2021-09-181-31/+0
| | | | | | | | | | | It doesn't exist any more and its functionality is now taken care of by "devtool check-upgrade-status" (From yocto-docs rev: 9c155e91dc57cb49b97805805e802330188a2c04) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to BitBake manualMichael Opdenacker2021-07-301-2/+2
| | | | | | | | | | | | | Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`" by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`" when the reference description is the same as the section name. In this case, that's unnecessary to repeat the section name in the description part. (From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If a variable has a glossary entry and some rST files write about those variables, it's better to point to the glossary entry instead of just highlighting it by surrounding it with two tick quotes. This was automated by the following python script: """ import re from pathlib import Path with open('objects.inv.txt', 'r') as f: objects = f.readlines() with open('bitbake-objects.inv.txt', 'r') as f: objects = objects + f.readlines() re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)') terms = [] for obj in objects: match = re_term.search(obj) if match and match.group(1): terms.append(match.group(1)) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".joing(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) """ (From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-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: simplify styleMichael Opdenacker2021-05-221-2/+1
| | | | | | | (From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: code insertion simplification over two linesMichael Opdenacker2021-04-231-32/+16
| | | | | | | | | | | | | | | This simplifies paragraphs ending with a colon and followed by code insertion. Automatically substituted through the command: sed -i -z "s/:\n\s*::/::/g" file.rst This generates identical HTML output. (From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-0/+844
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>