linux/poky.git/documentation/ref-manual/migration.rst, branch styhead-5.1.4

ref-manual: move migration guides to separate document

2021-06-14T21:45:33+00:00

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

ref-manual: add migration section for 3.3 release

2021-04-15T19:18:58+00:00

(From yocto-docs rev: b8b6e8335be382337fe4adda11d5a90872ff4c79) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

ref-manual: add migration section for 3.2

2020-10-30T12:09:21+00:00

This covers most of the changes that would require action on the part of the user that I was able to see by scouring the commits. Some of the text was borrowed from commit messages and edited. (From yocto-docs rev: 35e9349ba6417765274d7d1ce542e7e6f19dbe26) Signed-off-by: Paul Eggleton 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: ref-manual/migration: Split each release into its own file

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

This avoids the duplicate heading warnings at the slight expense of more directory clutter. (From yocto-docs rev: ef896d71836aa3bd6c926b36976a9c45d5f2ca15) Signed-off-by: Richard Purdie

sphinx: ref-manual links fixes and many other cleanups to import

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

(From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e) Signed-off-by: Richard Purdie

sphinx: add links to section in the Bitbake manual

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

Use intersphinx extension to replace links to the Bitbake manual with proper cross references. (From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: add links to terms in the BitBake glossary

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

Using the intersphinx extension, we can refer to terms in the Bitbake manual using :term:`bitbake:FOO`. This patch implements that, mostly using the following regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_BB_URL;)?#var(-bb)?-\\1>`__", ":term:`bitbake:\\1`", line) And a handful of manual fixup. (From yocto-docs rev: d2ed9117fffceb756c4a8f3cb6d39363a271d6d9) 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: add links for Yocto project website

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

In DocBook, variables are used to create custom links (note that it is not consistent everywhere, since some web addresses are still hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL, YOCTO_BUGS_URL and YOCTO_DL_URL.. In Sphinx they are replaced with extlinks. (From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie