Age | Commit message (Collapse) | Author | Files | Lines |
|
Due to an extra empty line between the option and its description
it is rendered not like in other places.
Remove the empty lines to fix.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-11-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Improper Capitalization.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-10-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
These two places are rendered like a table in the source (rst) code,
but they are seen as plain text by formatters, and thus are joined
together into a single line, e.g.:
> “root” - a partition root “member” - a non-root member of a partition
This is definitely not what was intended.
To fix, use table formatting, like in other places.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-9-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Due to an extra vertical whitespace, this was not recognised
as a definition list entry, and thus was not rendered like
the rest of cgroupfs files.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-8-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
- fix a typo (mempry -> memory) in a file name;
- add space before "(" where appropriate.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-7-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-6-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-4-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Fix the rendering of the paragraph. Before the fix, the first line is
rendered in bold (I'm not quite sure why) and is also separated from the
rest of the paragraph, which is rendered with an indent.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-3-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Since commit d6a3b247627a3 these three lines are merged into one by the
RST processor, making it hard to read. Use bullet points to separate
the entries, like it's done in other similar places.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Acked-by: Tejun Heo <tj@kernel.org>
Link: https://lore.kernel.org/r/20210120001824.385168-2-kolyshkin@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Kernel-doc currently expects that the kernel-doc markup to come
just before the function/enum/struct/union/typedef prototype.
Yet, if it find things like:
/**
* refcount_add - add a value to a refcount
* @i: the value to add to the refcount
* @r: the refcount
*/
static inline void __refcount_add(int i, refcount_t *r, int *oldp);
static inline void refcount_add(int i, refcount_t *r);
Kernel-doc will do the wrong thing:
foobar.h:6: warning: Function parameter or member 'oldp' not described in '__refcount_add'
.. c:function:: void __refcount_add (int i, refcount_t *r, int *oldp)
add a value to a refcount
**Parameters**
``int i``
the value to add to the refcount
``refcount_t *r``
the refcount
``int *oldp``
*undescribed*
Basically, it will document "__refcount_add" with the kernel-doc
markup for refcount_add.
If both functions have the same arguments, this won't even
produce any warning!
Add a logic to check if the kernel-doc identifier matches the actual
name of the C function or data structure that will be documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/081546f141a496d6cabb99a4adc140444c705e93.1610610937.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Signed-off-by: Rolf Eike Beer <eb@emlix.com>
Link: https://lore.kernel.org/r/2338863.uUFqZTUbry@devpool47
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Remove the make headers_check step from submit-checklist.rst as this is
no longer functional.
Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
Link: https://lore.kernel.org/r/1610458861-2832-1-git-send-email-milan.lakhani@codethink.co.uk
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Plenty of architectures are already supported and this adds ARM
support.
Signed-off-by: Marc Koderer <marc@koderer.com>
Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
Link: https://lore.kernel.org/r/20210112154054.17138-1-marc@koderer.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Clear-up any confusion surrounding the Fixes: tag with regards to the
need to Cc: the stable mailing list when submitting stable patch
candidates.
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210113163315.1331064-1-lee.jones@linaro.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
This commit links Korean translation of 'memory-barriers.txt' in the
translations index rst file as the original version is linked in
'Documentation/staging/index.rst'.
Signed-off-by: SeongJae Park <sjpark@amazon.de>
Link: https://lore.kernel.org/r/20210117100931.9347-4-sj38.park@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Translate this commit to Korean:
da514157c4f0 ("docs: make reporting-bugs.rst obsolete")
Signed-off-by: SeongJae Park <sjpark@amazon.de>
Link: https://lore.kernel.org/r/20210117100931.9347-3-sj38.park@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Apply this commit to Korean:
e7b4311ebcac ("Replace HTTP links with HTTPS ones: Documentation/process")
Signed-off-by: SeongJae Park <sjpark@amazon.de>
Link: https://lore.kernel.org/r/20210117100931.9347-2-sj38.park@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
The file Documentation/process/howto.rst points to bugzilla.kernel.org
as the primary place to report kernel bugs to. For most of the kernel
that's the wrong place, as the MAINTAINERS file shows. Adjust those
sections to make them match current practice.
This change also removes a contradiction with the recently added text
Documentation/admin-guide/reporting-issues.rst, which is a reason for a
'this needs further discussion' warning note in there. The change is
thus a prerequisite to remove that warning, nevertheless it is left for
now to make sure people review the text's approach more carefully.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210116143542.69199-1-linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
The Chinese mips translations refer to non-existing labels in the original
documentation. Hence, make htmldocs warns about those undefined labels on
all files in ./Documentation/translations/zh_CN/mips/.
Replace the references to non-existing labels with suitable doc references.
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Fixes: 419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")
Fixes: 72bc9d08868d ("doc/zh_CN: add mips features.rst translation")
Fixes: 7fd3954b0c52 ("doc/zh_CN: add mips booting.rst translation")
Fixes: b8e724fd7117 ("doc/zh_CN: add mips index.rst translation")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/r/20210113070557.28792-1-lukas.bulwahn@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
Commit 419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")
introduces a warning with make htmldocs:
./Documentation/translations/zh_CN/mips/ingenic-tcu.rst:
61: WARNING: Malformed table. Text in column margin in table line 6.
Adjust the table markup to address this warning.
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Fixes: 419b1d4ed1cb ("doc/zh_CN: add mips ingenic-tcu.rst translation")
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/r/20210113070023.25064-1-lukas.bulwahn@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|