linux/poky.git/documentation/kernel-dev, branch 3.3_M2Mirror of git.yoctoproject.org/pokyhttps://git.enea.com/cgit/linux/poky.git/atom?h=3.3_M22021-01-20T00:53:53+00:00docs: fix missing & and ; surrounding references from poky.yaml2021-01-20T00:53:53+00:00Quentin Schulzfoss@0leil.net2021-01-16T11:16:03+00:00urn:sha1:e6a0be545d73b1052a259547afd2aa63d4b58546
poky.yaml references are only replaced in files if they are prefixed by
& and suffixed by ;.
Let's fix the missing surrounding characters.
(From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation: Simplify oe_wiki and oe_home links2020-12-24T08:23:33+00:00Paul Barkerpbarker@konsulko.com2020-12-22T15:30:27+00:00urn:sha1:d903e586c219bca2f1967864a12a6164910a38e1
(From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sdk-manual: remove 'sdk' from filenames2020-12-09T12:21:27+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-12-03T21:38:42+00:00urn:sha1:79fecb25e15178ad1a0f56233a2d514340c14ab5
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
overview-manual: remove 'overview-manual' from filenames2020-12-09T12:21:27+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-12-03T21:38:41+00:00urn:sha1:3240a59758e918afa79d14c961492d6f98cc3d85
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: 4f489a40bb00be018e419802a76fec9dbee3f255)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
kernel-dev: remove 'kernel-dev' from filenames2020-12-09T12:21:27+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-12-03T21:38:39+00:00urn:sha1:a0afa48859def9f6410ad1d3b1296683e14fc2b7
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
dev-manual: remove 'dev-manual' from filenames2020-12-09T12:21:27+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-12-03T21:38:38+00:00urn:sha1:af6f5d821d39b50c3c4b45a593324346fce0d723
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: use absolute paths for :doc: references2020-12-09T12:21:27+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-12-03T21:38:35+00:00urn:sha1:097d0c9f04353866302efebcdd0b497c2b89cabb
: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 <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
sphinx: rename top level document in each manual2020-12-09T12:21:27+00:00Nicolas Dechesnenicolas.dechesne@linaro.org2020-12-03T21:38:34+00:00urn:sha1:bd1789261122c25d62b8e8e7f7d5647249e8d8ff
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation: Simplify yocto_git links2020-12-03T12:04:21+00:00Paul Barkerpbarker@konsulko.com2020-11-27T15:19:09+00:00urn:sha1:48748377a41a697a2b280ddbecb1c39487d1b7b8
The yocto_git external link directive is modified to include the
`/cgit/cgit.cgi` element of the URL so that we can simplify the links in
the text.
Manual links to git.yoctoproject.org are converted to use the yocto_git
directive where possible. Note that this directive can't be used in some
places such as example code.
(From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation: Simplify yocto_wiki links2020-12-03T12:04:21+00:00Paul Barkerpbarker@konsulko.com2020-11-27T15:19:08+00:00urn:sha1:8faafa99cc9a45c1920ec3ea696a9ec7fb653194
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 <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>