linux/poky.git/documentation/adt-manual, branch master

adt-manual: delete obsolete ADT manual, and related content

2020-10-30T16:03:19+00:00

Since the ADT manual has long been superseded by the SDK manual, remove the entire adt-manual directory, and the references to it in the two top-level files "conf.py" and "poky.yaml". (From yocto-docs rev: 64b2e83bddf6af0439ac7089ac95e60faa696cfc) Signed-off-by: Robert P. J. Day Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

docs: remove OE_INIT_FILE variable

2020-10-20T10:12:06+00:00

There's probably no need for such a variable (the name of the script is unlikely to change any time soon) and not all instances of oe-init-build-env were actually using this variable. For consistency sake, let's just remove the OE_INIT_FILE variable. Suggested-by: Nicolas Dechesne (From yocto-docs rev: 6fd4421283005b0ecc980e9ef25770d383b93937) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

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: replace special quotes with single and double quotes

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

(From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675) Signed-off-by: Quentin Schulz 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: fix links when the link text should be displayed

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

When an hyperlink should be display in the output, there is no need to any specific syntax or marker, the parser finds links and mail addresses in ordinary text. Somehow the conversion from pandoc generated wrong output in the form: ` `__. This patch is generated using the following Python regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) (From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: manual updates for some links

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

Some links were not found by the regexp, especially because of they are spanning across multiple lines. This patch is a manual fixup for these patterns. (From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5) 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: Add SPDX license headers

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

SPDX headers have been added to each file, and match the headers used in the DocBook files. (From yocto-docs rev: 79dbb0007ae24da4a3689a23e921f2a2638757f7) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie