linux/poky.git/documentation/kernel-dev/kernel-dev-common.rst, branch hardknott-next

kernel-dev: remove 'kernel-dev' 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: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a) 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

documentation: Simplify yocto_wiki links

2020-12-03T12:04:21+00:00

The `yocto_wiki` external link directive is modified to include the `/wiki` element of the URL so that we can simplify the links in the text. Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in index.rst. (From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d) Signed-off-by: Paul Barker Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

{dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO;

2020-12-03T12:04:20+00:00

In the Docbook files we had DISTRO, but somehow it was lost during the migration to Sphinx. (From yocto-docs rev: d10bb13070039e17281fccc5c1a64b5bfed30543) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

kernel-dev: remove unused labels

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

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

docs: kernel-dev-common: add .patch file extension to SRC_URI files

2020-10-27T13:23:00+00:00

Patches provided in SRC_URI are only applied if their extension is .diff or .patch. The examples do not use those extensions and would probably result in user confusion as to why the patches aren't being applied to the sources. Let's fix this by giving them a .patch file extension. (From yocto-docs rev: 0858e86ed8e3e3005207980041fe4f2117750663) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

docs: kernel-dev: fix typos, highlights and links

2020-10-27T13:23:00+00:00

(From yocto-docs rev: a69247321ff34cb0a2b9a8cc62020ec7f3aad834) 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