As reported by "make sphinx-lint"
Tabs are even removed in Makefile examples,
as Sphinx turns them to spaces anyway in the generated output.
(From yocto-docs rev: fd1423141e7458ba557db465c171b0b4e9063987)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
As reported by "make sphinx-lint"
(From yocto-docs rev: 18d86626406fe07d4f62ef0b9168c0220b3dd90a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
According to errors reported by "make stylecheck"
(From yocto-docs rev: b3aaf4523190f7528d49c29a9aea234bb1647eae)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Allowing to remove nested parentheses in the text!
(From yocto-docs rev: a0ba062f8b31426f80ccd760e29b054405ee2a8e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"
(From yocto-docs rev: f6e69f8877d1d33200993f21b448e7fa3cf7859b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Plus a few text styling improvements, some reported by "make stylecheck"
(From yocto-docs rev: ce0e83716197773d8eae0c2f0edc1cf290ebd60f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/
Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.
Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.
Fix a few misuses of parentheses in following text.
(From yocto-docs rev: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
The references to the target and host systems (i.e. the client and
server respectively) were swapped in the instructions.
Also, there's no need to specify the device node on the server command
line that is run on the host system.
The previous, incorrect, instructions resulted typically in:
target# blktrace -l /dev/mmcblk1
server: waiting for connections...
and
host$ blktrace -d /dev/mmcblk2 -h target
Invalid path /dev/mmcblk2 specified: 2/No such file or directory
unless the same device node happened to exist on the host system.
Based on
target# blktrace --version
blktrace version 2.0.0
and
host$ blktrace --version
blktrace version 2.0.0
(From yocto-docs rev: 6d16d2bde0aa32276a035ee49703e6eea7c7b29a)
Signed-off-by: Hannu Lounento <hannu.lounento@vaisala.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Otherwise rendered as "en" dashes by sphinx, for example:
git pull –rebase
instead of
git pull --rebase
Readers could confuse them with normal dashes.
Exception: replace by \-\- in italic text (*text*)
as Sphinx cannot nest italic and quoted text.
For consistency, also update quoting in strings in the same code hunks.
(From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Almost everyone understands "rootfs", but "root filesystem"
is real English.
(From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
https has been the preferred way to access websites for many years now.
Change all of the URLs with a _working_ https server/certificate to use
that URL.
(From yocto-docs rev: c77868c780df94356d5f21453f80ace073fade9b)
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Thanks to closing yocto bug #3388, there is now a simple way
to build the perf manpages for use on the target
(From yocto-docs rev: 12dd3ecb054c1668cdccc220ca21b88635531784)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This replaces instances of ": ::" by "::", which
generates identical HTML output
(From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Spelling fixes found using Emacs' spelling checker
configured for US English
- Fixes for some capitalization issues, especially some
project names (QEMU, openSUSE, BusyBox), that were not
consistently used with the same capitalization anyway.
- A few whitespace fixes too
(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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: 44405490888960208058d016e387507e21c9f478)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
