summaryrefslogtreecommitdiffstats
path: root/documentation/migration-guides/migration-1.3.rst
Commit message (Collapse)AuthorAgeFilesLines
* manuals: simplify references to classesMichael Opdenacker2023-01-061-6/+6
| | | | | | | | | | | | | | | 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 classesMichael Opdenacker2022-12-011-11/+10
| | | | | | | | | | | Sometimes fixing line length in modified paragraphs too. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_unpack" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 1ca57f8ec322d5777bf31829e659d62e82986be1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_patch" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 1e38ceafb25aac13bb9dd45626fd39ad1b68852d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve references to classesMichael Opdenacker2022-02-031-1/+1
| | | | | | | | | | | | | | | | | | | | | - Simplify references to class sections, by replacing references such as :ref:`image.bbclass <ref-classes-image>` by :ref:`ref-classes-image` That's equivalent, because the class sections always called <class>.bbclass - Adding references to class sections, by replacing strings such as ``image.bbclass`` by :ref:`ref-classes-image` - Simplifying a few class section links (From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: move migration guides to separate documentMichael Opdenacker2021-06-141-0/+194
This makes the reference manual much lighter by moving the migration guides to a separate document. The migration guides are also reordered from last to first, and they appear directly in the left bar, making them easier to find in the documentation. (From yocto-docs rev: 5121b86ee97eb62a0c69c9ad1fc0e3fabbe3e934) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>