- 21 Jan, 2021 23 commits
-
-
Mauro Carvalho Chehab authored
The kernel-doc markups on this file are weird: they don't follow what's specified at: Documentation/doc-guide/kernel-doc.rst In particular, markups should use this format: identifier - description and not this: identifier(args) The way the definitions are inside this file cause the parser to completely miss the identifier name of each function. This prevents improving the script to do some needed validation tests. Address this part. Yet, furter changes are needed in order for it to fully follow the specs. Acked-by:Kees Cook <keescook@chromium.org> Signed-off-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/8383758160fdb4fcbb2ac56beeb874ca6dffc6b9.1610610937.git.mchehab+huawei@kernel.orgSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
A function has a different name between their prototype and its kernel-doc markup. Signed-off-by:
-
Mauro Carvalho Chehab authored
Some identifiers have different names between their prototypes and the kernel-doc markup. Acked-by:
Mike Rapoport <rppt@linux.ibm.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
A function has a different name between their prototype and its kernel-doc markup. Signed-off-by:
-
Mauro Carvalho Chehab authored
A function has a different name between their prototype and its kernel-doc markup. Signed-off-by:
-
Mauro Carvalho Chehab authored
There are some common comments marked, instead, with kernel-doc notation, which won't work. While here, rename an identifier, in order to match the function prototype below kernel-doc markup. Acked-by:
Richard Gong <richard.gong@linux.intel.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
The documented struct is psz_head and not psz_buffer. Reviewed-by:
-
Mauro Carvalho Chehab authored
Two markups are at the wrong place. Kernel-doc only support having the comment just before the identifier. Also, some identifiers have different names between their prototypes and the kernel-doc markup. Signed-off-by:
-
Mauro Carvalho Chehab authored
Probaly this was due to a cut and paste issue. Signed-off-by:
-
Mauro Carvalho Chehab authored
The kernel-doc markup inside share.c is actually for __parport_register_driver. The actual goal seems to be to document parport_register_driver(). So, fix the existing markup and add a new one. Signed-off-by:
-
Randy Dunlap authored
Fix typos (punctuation, grammar, spelling) in afs.rst. Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Cc: David Howells <dhowells@redhat.com> Cc: linux-afs@lists.infradead.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20210117213351.1075-1-rdunlap@infradead.orgSigned-off-by:
-
Alex Shi authored
It's a unused tag with a incorrect big name but just for mips arch. So remove it. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Yanteng Si <siyanteng@loongson.cn> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20210121024113.16344-1-alex.shi@linux.alibaba.comSigned-off-by:
-
Yanteng Si authored
There are two EP9312, one of them should be 9315 Signed-off-by:
Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20210119030320.2860870-1-siyanteng@loongson.cnSigned-off-by:
-
Lukas Bulwahn authored
Commit adab66b7 ("Revert: "ring-buffer: Remove HAVE_64BIT_ALIGNED_ACCESS"") added the config HAVE_64BIT_ALIGNED_ACCESS back into arch/Kconfig with this revert. In the meantime, commit c9b54d6f ("docs: move other kAPI documents to core-api") changed ./Documentation/unaligned-memory-access.txt to ./Documentation/core-api/unaligned-memory-access.rst. Fortunately, ./scripts/documentation-file-ref-check detects this and warns about this broken reference. Update the file reference in arch/Kconfig. Fixes: adab66b7 ("Revert: "ring-buffer: Remove HAVE_64BIT_ALIGNED_ACCESS"") Signed-off-by:
Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20210119095326.13896-1-lukas.bulwahn@gmail.comSigned-off-by:
-
Kir Kolyshkin authored
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.comSigned-off-by:
-
Kir Kolyshkin authored
Improper Capitalization. Signed-off-by:
-
Kir Kolyshkin authored
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 authored
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 authored
- fix a typo (mempry -> memory) in a file name; - add space before "(" where appropriate. Signed-off-by: -
Kir Kolyshkin authored
Signed-off-by:
-
Kir Kolyshkin authored
Signed-off-by:
-
Kir Kolyshkin authored
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 authored
Since commit d6a3b247 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:
-
- 18 Jan, 2021 9 commits
-
-
Mauro Carvalho Chehab authored
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:
-
Rolf Eike Beer authored
Signed-off-by:
Rolf Eike Beer <eb@emlix.com> Link: https://lore.kernel.org/r/2338863.uUFqZTUbry@devpool47Signed-off-by:
-
Milan Lakhani authored
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.ukSigned-off-by:
-
Marc Koderer authored
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.comSigned-off-by:
-
Lee Jones authored
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.orgSigned-off-by:
-
SeongJae Park authored
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.comSigned-off-by:
-
SeongJae Park authored
Translate this commit to Korean: da514157 ("docs: make reporting-bugs.rst obsolete") Signed-off-by: -
SeongJae Park authored
Apply this commit to Korean: e7b4311e ("Replace HTTP links with HTTPS ones: Documentation/process") Signed-off-by: -
Thorsten Leemhuis authored
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:
-
- 13 Jan, 2021 2 commits
-
-
Lukas Bulwahn authored
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:
Stephen Rothwell <sfr@canb.auug.org.au> Link: https://lore.kernel.org/r/20210113070557.28792-1-lukas.bulwahn@gmail.comSigned-off-by:
-
Lukas Bulwahn authored
Commit 419b1d4e ("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:
-
- 12 Jan, 2021 4 commits
-
-
Yanteng Si authored
This patch translates Documentation/mips/ingenic-tcu.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
This patch translates Documentation/mips/features.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
This patch translates Documentation/mips/booting.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
This patch translates Documentation/mips/index.rst into Chinese. Signed-off-by:
Jiaxun Yang <jiaxun.yang@flygoat.com> Link: https://lore.kernel.org/r/20210112115259.217944-1-siyanteng@loongson.cnSigned-off-by:
-
- 11 Jan, 2021 2 commits
-
-
Marc Koderer authored
The example file supports many architectures not only x86 and PPC. Signed-off-by:
-
Johannes Thumshirn authored
Hannes reported a problem with setting up dma transfers on a mcb device. The problem boiled down to the use of a wrong 'device' for the dma functions. Document how to setup dma transfers for a IP core on a mcb carrier. Reported-by:
Hannes Duerr <Hannes.Duerr@duagon.com> Signed-off-by:
Johannes Thumshirn <johannes.thumshirn@wdc.com> Link: https://lore.kernel.org/r/3bdc8f76b30c2b0e2a2bfab06c2e73797ddc9384.1608305690.git.johannes.thumshirn@wdc.comSigned-off-by:
-
