linux/poky.git/documentation/what-i-wish-id-known.rst, branch mickledore-next

manuals: split dev-manual/common-tasks.rst

2022-12-01T19:20:29+00:00

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 Signed-off-by: Richard Purdie

manuals: improve the width of diagrams

2022-05-10T11:52:35+00:00

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 Signed-off-by: Richard Purdie

manuals: fix name capitalization issues

2022-05-10T11:52:34+00:00

- 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 Signed-off-by: Richard Purdie

manuals: replace "rootfs" by "root filesystem"

2022-01-07T11:12:06+00:00

Almost everyone understands "rootfs", but "root filesystem" is real English. (From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation: Simplify layerindex and layer links

2020-12-24T08:23:33+00:00

(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

sdk-manual: remove 'sdk' from filenames

2020-12-09T12:21:27+00:00

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: bd8c0f7fc09a39a8bbde1c05b51693955738e148) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

dev-manual: remove 'dev-manual' from filenames

2020-12-09T12:21:27+00:00

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 Signed-off-by: Richard Purdie

sphinx: use absolute paths for :doc: references

2020-12-09T12:21:27+00:00

:doc: references can be made with absolute path instead of relative path. This patch was generated with this command: sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst And a few manual fixup we made for references such as: :doc:"FOOBAR <../xxx>" Suggested-by: Robert P. J. Day (From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: rename top level document in each manual

2020-12-09T12:21:27+00:00

It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

what-i-wish-id-known: replace labels with references to section title

2020-11-20T14:32:25+00:00

(From yocto-docs rev: 27779317d5406d2f79c907bd1d6d5d3748afed7e) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie