linux/poky.git/documentation/profile-manual, branch gatesgarth-next

docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK

2020-10-08T10:28:30+00:00

When the license identifier tags were added, an incorrect string was used and the Share-Alike clause was lost. Fix this to match the license description in the files and add back the lost piece (its clear from the history it should be there) (From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Richard Purdie

sphinx: remove DocBook files

2020-10-06T12:56:17+00:00

The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: profile-manual: convert profile-manual

2020-09-17T09:09:35+00:00

Last round of manual fixes for remaining links and conversion problems left after the automatic conversion. (From yocto-docs rev: 071bca4573bc8c60aef1d89896d6536867fe46e5) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: insert blank below between title and toc

2020-09-17T09:09:34+00:00

Whenever a TOC follows a title/heading, a blank line is missing. So let's add it explicitely. (From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: manuals: Move boilerplate after toctree

2020-09-17T09:09:34+00:00

The boilerplate looks better after the ToC, still not quite right but the boilerplate can be improved from here. (From yocto-docs rev: 5e81b9c90f6f45acf26ba146e280bc2659ac14e5) Signed-off-by: Richard Purdie

sphinx: history: Move revision history to its own section

2020-09-17T09:09:34+00:00

The revision history tables look better in their own section, move them. (From yocto-docs rev: 27bf0f69b6dc04cea97a023ef52bec2b213d074f) Signed-off-by: Richard Purdie

sphinx: fix up bold text for informalexample container

2020-09-17T09:09:34+00:00

With DocBook the 'informalcontainer' include a 'title' which was rendered as bold with CSS. However when using the Sphinx container directive to create a custom container, it's just content without title, so make the title bold. (From yocto-docs rev: 8947e6b71baa6c9bf06751018bc2b98f8be1b6fd) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: profile-manual: add figures

2020-09-17T09:09:34+00:00

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

sphinx: fix internal links

2020-09-17T09:09:33+00:00

Many of the internal links were not converted probably from DocBook using pandoc. After looking at the various patterns, the follow series of 'naive' Python regexp were used to perform some additional automatic conversion. Also, since we rely on built-in glossary, all links to terms need to use the sphinx :term: syntax. This commit is generated using the following Python series of regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__", ":term:`\\1`", line) line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__", ":ref:`ref-tasks-\\1`", line) line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1.bbclass `", line) line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1 `", line) line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__", ":term:`Source Directory`", line) line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__", ":term:`Build Directory`", line) line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__", ":term:`Metadata`", line) line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__", ":term:`BitBake`", line) line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__", ":ref:`ref-manual/ref-images:Images`", line) line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__", ":ref:`ref-manual/ref-classes:Classes`", line) line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__", ":ref:`devtool-the-workspace-layer-structure`", line) line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__", ":term:`OpenEmbedded Build System`", line) line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__", ":term:`OpenEmbedded-Core (OE-Core)`", line) It won't catch multiline strings, but it catches a very large number of occurences! (From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: ref-manual: add revision history table

2020-09-17T09:09:33+00:00

(From yocto-docs rev: 36d1073119081b9c364f48aedf4086881bef03d6) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie