Re: [PATCH] README: Improve documentation descriptions

On Fri, 16 Mar 2018 16:57:07 +0100 Martin Kepplinger wrote: > "This file" indeed was moved once, but at some point "this file", the > top-level README, becomes a file in itself. Now that time has come :) > > Let's describe how things are, and suggest reading "this file"

[PULL] Documentation build fix

The following changes since commit e67548254b86a4a6e1b493f041bb7fe28ee74249: Merge tag 'mips_fixes_4.16_4' of git://git.kernel.org/pub/scm/linux/kernel/git/jhogan/mips (2018-03-08 10:03:12 -0800) are available in the Git repository at: git://git.lwn.net/linux.git tags/docs-4.16-fix for

Re: [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST

On Fri, 9 Mar 2018 00:40:16 +0100 Jonathan Neuschäfer wrote: > The aim of this patchset is to move the GPIO subsystem's documentation > under Documentation/driver-api/gpio/ such that it is picked up by Sphinx > and compiled into HTML. I moved everything except for

Re: [PATCH] [v2] docs: clarify security-bugs disclosure policy

On Wed, 7 Mar 2018 13:53:06 -0800 Linus Torvalds wrote: > I'm guessing this will go through Jon? Sounds like a fine guess to me; will apply shortly. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH 00/17] Include linux trace docs to Sphinx TOC tree

I had to append the attached patch to the series to make those problems go away. The warnings are there for a purpose! Anyway, with that, the patch series is applied. Thanks for helping to improve the docs, and my apologies for taking so long to get to this. jon >From 6234c7bd8c14508fb76c0a4d6f01eb81c8ce9

Re: [PATCH 2/2] docs: add Co-Developed-by docs

On Mon, 5 Mar 2018 14:58:21 +1100 "Tobin C. Harding" wrote: > When Co-Developed-by tag was added, docs were only added to > Documention/process/5.Posting.rst and were not added to > Documention/process/submitting-patches.rst > > Add documentation to

Re: [PATCH v3] Documentation/sphinx: Fix Directive import error

On Fri, 2 Mar 2018 10:40:14 -0800 Matthew Wilcox wrote: > Sphinx 1.7 removed sphinx.util.compat.Directive so people > who have upgraded cannot build the documentation. Switch to > docutils.parsers.rst.Directive which has been available since > docutils 0.5 released in 2009.

Re: [PATCH] documentation: add my name to kernel driver statement

On Tue, 6 Mar 2018 09:46:28 -0800 Greg Kroah-Hartman wrote: > Jon, can you pick this up or do you need me to forward this to you? I've got it, no worries. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH] Documentation/sphinx: Fix Directive import error

On Fri, 02 Mar 2018 15:55:06 +0100 Takashi Iwai wrote: > Jon, would you like me resending the patch? Or it's trivial enough as > you can fix in place. If you can resend that would be great - one less thing for me to have to squeeze in :) Thanks, jon -- To unsubscribe from this

Re: kernel-doc unbuildable with sphinx 1.7

On Fri, 02 Mar 2018 15:44:45 +0100 Takashi Iwai wrote: > Sure, just waited for the feedback from Jon :) I want to try it with both old and new Sphinx, of course, but will have a hard time doing it today - on the road all day. But it looks reasonable at a first glance; I'll try

Re: kernel-doc unbuildable with sphinx 1.7

On Fri, 2 Mar 2018 15:10:14 +0100 Jiri Slaby wrote: > in openSUSE, sphinx was updated to 1.7.1 and kernel-doc cannot be built > since that time: > Running Sphinx v1.7.1 > > Extension error: > Could not import extension kerneldoc (exception: cannot import name > 'Directive') > >

Re: [PATCH v2] Documentation: rapidio: move sysfs interface to ABI

On Fri, 19 Jan 2018 18:01:47 +0530 Aishwarya Pant wrote: > Right now, the description of the rapidio sysfs interfaces is in > Documentation/rapidio/sysfs.txt. Since these are a part of the ABI, they > should be in Documentation/ABI along with the rest. > > Signed-off-by:

Re: [PATCH v2] block/loop: add documentation for sysfs interface

On Sat, 17 Feb 2018 11:43:04 +0530 Aishwarya Pant wrote: > Documentation has been compiled from git logs and by reading through > code. > > Signed-off-by: Aishwarya Pant > --- > For drivers/block/loop.c, I don't see any maintainers or mailing lists

Re: [PATCH] doc-guide: kernel-doc: add comment about formatting verification

On Tue, 20 Feb 2018 20:36:25 +0200 Mike Rapoport wrote: > Currently there is no automated checking for kernel-doc comments except > running 'kernel-doc -v -none '. Mention the possibility to run > kernel-doc to verify formatting of the comments in the kernel-doc guide. >

Re: [PATCH v2] doc: admin-guide/module-signing.rst fixes

On Mon, 19 Feb 2018 10:39:00 +0100 Philipp Hahn wrote: > Two trivial corrections for the module signing documentation. > > v2: Add missing Signed-off-by > > Philipp Hahn (2): > doc: Rename .system_keyring to .builtin_trusted_keys > doc: module-signing.rst: Fix reST

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

On Wed, 21 Feb 2018 16:37:50 -0800 Kees Cook wrote: > As recently pointed out by Linus, "Root-caused-by" is a good tag to include > since it can indicate significantly more work than "just" a Reported-by. > This adds it and "Suggested-by" (which was also missing) to the

Re: [PATCH 05/17] trace doc: convert trace/ftrace.txt to rst format

On Tue, 20 Feb 2018 10:26:44 -0500 Steven Rostedt wrote: > One it should be a separate patch. Two, how does SPDX deal with dual > licenses? Separate them with "OR" on a single line. See Documentation/process/license-rules.rst for details. jon -- To unsubscribe from this

Re: [PATCH] linux-next: SLIMbus: doc: Fix a warning "Title underline too short"

On Mon, 19 Feb 2018 22:55:50 +0900 Masanari Iida wrote: > This patch fixes a warning during "make xmldocs" > > Documentation/driver-api/slimbus.rst:93: > WARNING: Title underline too short. > > Signed-off-by: Masanari Iida Applied, thanks. jon

Re: [RFC PATCH 0/3] Introduce Linux kernel labs documentation

On Mon, 19 Feb 2018 14:53:22 +0100 Octavian Purdila wrote: > We noticed that some APIs we used don't have kernel doc comments. > Would it be appropriate to add them as separate patches in this > series? Absolutely, though they should generally go through the appropriate

Re: [PATCH] admin-guide: Fix list formatting in tained-kernels.html

On Tue, 13 Feb 2018 23:36:51 +0100 Jonathan Neuschäfer wrote: > Without this patch, the points 1-9 in the list are rendered as an HTML > blockquote containing a list, causing them to be indented further than > the rest of the list. > > While at it, also fix the quotation

Re: [RFC PATCH 0/3] Introduce Linux kernel labs documentation

On Sun, 11 Feb 2018 20:05:43 +0200 Daniel Baluta wrote: > The Linux kernel labs documentation is a collection of "labs" for > various device driver topics. For each topic there are two parts: a > walk-through which explain the basic concepts and a hands-on part which >

Re: [PATCH 0/6] Add support for in-line nested struct comments

On Fri, 16 Feb 2018 11:48:14 -0200 Mauro Carvalho Chehab wrote: > his series fix two bugs at kernel-doc.rst examples and add support > for in-line nested struct comments. > > It also converts one documentation at intel_dpio_phy to use it, > in order to give a practical

Re: [PATCH] Documentation/process/howto: Remove outdated info about bugzilla mailing lists

On Tue, 13 Feb 2018 23:06:32 +0100 Jonathan Neuschäfer wrote: > The mailing list archives[1,2] show no activity since September 2011. > > [1]: https://lists.linuxfoundation.org/pipermail/bugme-new/ > [2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/

Re: [PATCH] scripts: kernel_doc: fixup reporting of function identifiers

On Fri, 16 Feb 2018 17:36:07 +0100 Markus Heiser wrote: > > So let me channel akpm here and ask: what are the user-visible effects of > > this problem? I ask because applying it doesn't make any difference in > > the "make htmldocs" output here. So I don't understand

Re: [PATCH] scripts: kernel_doc: fixup reporting of function identifiers

On Tue, 13 Feb 2018 13:31:46 +0200 Mike Rapoport wrote: > When function description includes brackets after the function name as > suggested by Documentation/doc-guide/kernel-doc, the kernel-doc script > omits the function name from "Scanning doc for" report. > Extending

Re: [PATCH] Documentation: Delete reference to the kernel-mentors mailing list

On Thu, 15 Feb 2018 20:03:14 -0500 Minghui Liu wrote: > Delete reference to the kernel-mentors mailing list because the mailing list > no longer exists > > Signed-off-by: Minghui Liu It does indeed seem to have vanished. Applied, thanks.

Re: [PATCH 2/3] Documentation: convert trace/ftrace-design.txt to rst format

On Thu, 15 Feb 2018 22:57:05 -0500 Steven Rostedt wrote: > This document is out of date, and I rather have it updated before we > make it more "available" elsewhere. Imagine that, an out-of-date doc in the kernel :) Seriously, though, I'd argue that (1) it's already highly

[PATCH 3/8] docs: kernel-doc: Move STATE_NORMAL processing into its own function

Begin the process of splitting up the nearly 500-line process_file() function by moving STATE_NORMAL processing to a separate function. Reviewed-by: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 21 -

[PATCH 1/8] docs: kernel-doc: Get rid of xml_escape() and friends

XML escaping is a worry that came with DocBook, which we no longer have any dealings with. So get rid of the useless xml_escape()/xml_unescape() functions. No change to the generated output. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-do

[PATCH 2/8] docs: kernel-doc: Rename and split STATE_FIELD

process_file() splitup easier. Reviewed-by: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 22 +++--- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index

[PATCH 4/8] docs: kernel-doc: Move STATE_NAME processing into its own function

Move this code out of process_file() in the name of readability and maintainability. Reviewed-by: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 137 - 1 file changed, 7

[PATCH 5/8] docs: kernel-doc: Move STATE_BODY processing to a separate function

Also group the pseudo-global $leading_space variable with its peers. Reviewed-by: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 193 - 1 file changed, 101 inser

[PATCH 6/8] docs: kernel-doc: Move STATE_PROTO processing into its own function

Move the top-level prototype-processing code out of process_file(). Reviewed-by: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 46 -- 1 file changed, 28 insertions(+), 18 deleti

[PATCH 8/8] docs: kernel-doc: Don't mangle literal code blocks in comments

ugly, but that means it fits in well with the rest of the script. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 69 ++ 1 file changed, 64 insertions(+), 5 deletions(-) diff --git a/scripts/kernel-doc b/scripts/ker

[PATCH 7/8] docs: kernel-doc: Finish moving STATE_* code out of process_file()

Move STATE_INLINE and STATE_DOCBLOCK code out of process_file(), which now actually fits on a single screen. Delete an unused variable and add a couple of comments while I'm at it. Reviewed-by: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net>

[PATCH v2 0/8] docs: Cleanup kernel-doc and fix literal block handling

dev-tools/kselftest.rst. Jonathan Corbet (8): docs: kernel-doc: Get rid of xml_escape() and friends docs: kernel-doc: Rename and split STATE_FIELD docs: kernel-doc: Move STATE_NORMAL processing into its own function docs: kernel-doc: Move STATE_NAME processing into its own function docs: kernel

Re: [PATCH v2 0/5] Restructure kernel-doc.rst

On Tue, 13 Feb 2018 13:15:32 -0800 Matthew Wilcox wrote: > Jon asked me to redo the Context: patch on top of his current docs tree. > Unfortunately, I was on a plane at the time, so I started fixing some > other small things, and before I knew it, I'd completely restructured

Re: [PATCH] Documentation/process: Co-developed-by instead of Co-Developed-by

On Sat, 10 Feb 2018 13:55:15 +0100 Dominik Brodowski wrote: > Up to now, all commit messages have used the "d" in lower case. Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH] tracing: Fix incorrect file name

On Sun, 04 Feb 2018 18:14:24 +0800 Xiongwei Song wrote: > There is no file named 'enabled' in the directory tracing/events. It should > be the file 'enable'. Makes sense, applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe

Re: [PATCH 0/6] Restructure kernel-doc.rst

On Thu, 8 Feb 2018 06:45:07 -0800 Matthew Wilcox wrote: > Jon asked me to redo the Context: patch on top of his current docs tree. > Unfortunately, I was on a plane at the time, so I started fixing some > other small things, and before I knew it, I'd completely restructured

Re: [PATCH 1/8] docs: kernel-doc: Get rid of xml_escape() and friends

On Fri, 09 Feb 2018 11:09:27 +0200 Jani Nikula <jani.nik...@linux.intel.com> wrote: > On Wed, 07 Feb 2018, Jonathan Corbet <cor...@lwn.net> wrote: > > XML escaping is a worry that came with DocBook, which we no longer have any > > dealings with. So get ri

Re: [PATCH 7/8] docs: kernel-doc: Finish moving STATE_* code out of process_file()

On Thu, 8 Feb 2018 13:29:53 +1100 "Tobin C. Harding" wrote: > It doesn't appear to be introduced by you but the brace positions are > non-uniform in this patch. > > if > { > ... > } > else > { > ... > } > > instead of > > if { > ... > } else { > eee > } True, that's

[PATCH 1/8] docs: kernel-doc: Get rid of xml_escape() and friends

XML escaping is a worry that came with DocBook, which we no longer have any dealings with. So get rid of the useless xml_escape()/xml_unescape() functions. No change to the generated output. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-do

[PATCH 5/8] docs: kernel-doc: Move STATE_BODY processing to a separate function

Also group the pseudo-global $leading_space variable with its peers. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 193 - 1 file changed, 101 insertions(+), 92 deletions(-) diff --git a/scripts/kernel-doc b/s

[PATCH 3/8] docs: kernel-doc: Move STATE_NORMAL processing into its own function

Begin the process of splitting up the nearly 500-line process_file() function by moving STATE_NORMAL processing to a separate function. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 21 - 1 file changed, 16 insertions(+), 5 deletions(-) diff

[PATCH 4/8] docs: kernel-doc: Move STATE_NAME processing into its own function

Move this code out of process_file() in the name of readability and maintainability. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 137 - 1 file changed, 72 insertions(+), 65 deletions(-) diff --git a/scripts/

[PATCH 2/8] docs: kernel-doc: Rename and split STATE_FIELD

process_file() splitup easier. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 22 +++--- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 5aa4ce211fc6..ad30c52f91ef 100755 --- a/scripts/kern

[PATCH 6/8] docs: kernel-doc: Move STATE_PROTO processing into its own function

Move the top-level prototype-processing code out of process_file(). Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 46 -- 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kern

[PATCH 8/8] docs: kernel-doc: Don't mangle literal code blocks in comments

hem, which is then treated as literal by sphinx. The result is unsightly markup instead of a useful code snippet. Apply a hack to the output code to recognize literal blocks and avoid performing any special markup on them. It's ugly, but that means it fits in well with the rest of the script. Signed-off-by

[PATCH 7/8] docs: kernel-doc: Finish moving STATE_* code out of process_file()

Move STATE_INLINE and STATE_DOCBLOCK code out of process_file(), which now actually fits on a single screen. Delete an unused variable and add a couple of comments while I'm at it. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc

[PATCH 0/8] Clean up kernel-doc and fix literal-block handling

blocks. If anybody was unaware that I've not done any serious Perl since the 1990's, they will certainly understand that fact now. Jonathan Corbet (8): docs: kernel-doc: Get rid of xml_escape() and friends docs: kernel-doc: Rename and split STATE_FIELD docs: kernel-doc: Move STATE_NORMAL

[PULL] A few more documentation changes for 4.16

The following changes since commit 255442c93843f52b6891b21d0b485bf2c97f93c3: Merge tag 'docs-4.16' of git://git.lwn.net/linux (2018-01-31 19:25:25 -0800) are available in the Git repository at: git://git.lwn.net/linux.git tags/docs-4.16-2 for you to fetch changes up to

Re: [PATCH] Mention kernel-doc Context section

On Fri, 19 Jan 2018 08:26:08 -0800 Matthew Wilcox wrote: > The scripts/kernel-doc processor mentions the ability to add arbitrary > section names and suggests including a Context: section. We already > have about 450 Context: sections in the kernel, so document it. > > We

Re: [PATCH] Fix broken link in Documentation/process/kernel-docs.rst

On Tue, 30 Jan 2018 15:58:06 +0300 Grigory Shipunov wrote: > Kernel Glossary has moved from /Glossary to /KernelGlossary > on kernelnewbies.org. This patch corrects this link. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH v2] Documentation/process: kernel maintainer PGP guide

On Thu, 1 Feb 2018 09:42:33 -0500 Konstantin Ryabitsev wrote: > This guide is an adapted version of the more general "Protecting Code > Integrity" guide written and maintained by The Linux Foundation IT for > use with open-source projects. It provides the

[PULL] Documentation for 4.16

documentation Fabio Estevam (1): doc: usb: chipidea: Fix typo in 'enumerate' Gergo Huszty (1): Fixed typo in onewire generic doc Jonathan Corbet (3): docs: Add an intro note to the maintainers handbook docs: Remove "could not extract kernel version" warning vsp

Re: [PATCH] linux-next: docs-rst: Fix typos in kfigure.py

On Thu, 11 Jan 2018 20:00:28 +0900 Masanari Iida wrote: > This patch fixes some spelling typos found in kfigure.py > > Signed-off-by: Masanari Iida Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in

Re: [PATCH] linux-next: DOC: HWPOISON: Fix path to debugfs in hwpoison.txt

On Thu, 11 Jan 2018 22:28:37 +0900 Masanari Iida wrote: > This patch fixes an incorrect path for debugfs in hwpoison.txt > > Signed-off-by: Masanari Iida Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc"

Re: [PATCH] Documentation: Fix misconversion of #if

On Tue, 16 Jan 2018 19:40:55 -0800 Matthew Wilcox wrote: > At some stage of the conversion pipeline, something thought that the > DocBook entity should be rendered as NUM instead of #. Haven't you heard? It's a new, improved form of C trigraph... :) Applied, thanks. jon

Re: [RFC] doc: fix code snippet build warnings

On Wed, 10 Jan 2018 15:04:53 +1100 "Tobin C. Harding" wrote: > Posting as RFC in the hope that someone knows how to massage sphinx > correctly to fix this patch. > > Currently function kernel-doc contains a multi-line code snippet. This > is causing sphinx to emit 5 build

Re: Protecting code integrity with PGP (kernel developer version)

On Tue, 9 Jan 2018 16:40:48 -0500 Konstantin Ryabitsev wrote: > Does such document belong with the rest of the kernel docs in the tree, > or should it remain fully external? I'll be happy to port it to RST if > you think it should live alongside other documents

Re: [PATCH] docs: add index entry for networking/msg_zerocopy

On Sat, 6 Jan 2018 12:30:37 +1100 "Tobin C. Harding" wrote: > Currently msg_zerocopy is not included in any toctree. Sphinx emits a > build warning to this effect. The other three rst files in > Documentation/networking are all indexed. We can add msg_zerocopy to the > toctree to

Re: [PATCH] docs-rst: networking: wire up msg_zerocopy

On Tue, 09 Jan 2018 11:50:49 -0500 (EST) David Miller wrote: > From: Mike Rapoport > Date: Mon, 8 Jan 2018 08:50:17 +0200 > > > Fix the following 'make htmldocs' complaint: > > > > Documentation/networking/msg_zerocopy.rst:: WARNING: document

Re: [PATCH] Documentation: security/credentials.rst: explain need to sort group_list

On Mon, 08 Jan 2018 10:39:14 +1100 NeilBrown wrote: > > There is value in using the c:func syntax, as it will generate > > cross-references to the kerneldoc comments for those functions. In this > > case, it would appear that these comments exist, but nobody has pulled > > them

Re: [PATCH] Documentation: security/credentials.rst: explain need to sort group_list

On Tue, 2 Jan 2018 13:04:31 -0800 Matthew Wilcox wrote: > > +When replacing the group list, the new list must be sorted before it > > +is added to the credential, as a binary search is used to test for > > +membership. In practice, this means ``groups_sort()`` should be >

Re: scripts/kernel-doc: no warning or error on lots of missing function parameters

On Sat, 30 Dec 2017 16:54:30 -0800 Randy Dunlap wrote: > > Please check if the enclosed patches fix the issue. > > > > Regards, > > Mauro > > > > Yes, this seems to be working (I am just doing a quick look for now). > > Acked-and-Tested-by: Randy Dunlap

Re: [PATCH] doc: md: Fix a file name to md-fault.c in fault-injection.txt

On Sat, 23 Dec 2017 01:41:21 +0900 Masanari Iida wrote: > drivers/md/faulty.c has been renamed to md-faulty.c after > following commit merged int to the main line. > > 935fe0983e09f4f7331ebf5ea4ae2124f6e9f9e8 . > > But the file name in fault-injection.txt has not been

Re: [PATCH v2] errseq: Add to documentation tree

On Fri, 22 Dec 2017 06:32:16 -0800 Matthew Wilcox wrote: > - Move errseq.rst into core-api > - Add errseq to the core-api index > - Promote the header to a more prominent header type, otherwise we get three >entries in the table of contents. > - Reformat the table to

Re: [PATCH v2 0/2] mux: add overview and add to driver-api docs

On Tue, 12 Dec 2017 09:46:31 +0100 Peter Rosin wrote: > Changes since v1: > - added a short introductory paragraph to mux.rst > - added an entry in MAINTAINERS. > > I forgot to mention that this applies on top of linux-next, I suspect > there will be a trivial conflict with an

Re: [PATCH v4 00/18] kernel-doc: add supported to document nested structs

On Mon, 18 Dec 2017 10:30:01 -0200 Mauro Carvalho Chehab wrote: > This is a rebased version of my patch series that add support for > nested structs on kernel-doc. With this version, it won't produce anymore > hundreds of identical warnings, as patch 17 removes the

Re: [PATCH v2] i2c: update i2c-dev.h warning in documentation

On Thu, 21 Dec 2017 23:49:16 +0300 Cengiz Can wrote: > I've ditched claws-mail and will use git send-mail instead. FWIW, I use claws for patch mailing and more. It can be made to work, you just need to tweak the options a bit. The trick is to send patches to yourself and

Re: [PATCH] docs: fix process/submit-checklist.rst Sphinx warning

On Tue, 12 Dec 2017 11:46:51 +0100 Markus Heiser wrote: > add missing indent whitespace to list item, fixes the warning: > > - process/submit-checklist.rst:41: WARNING: Enumerated list ends without a > blank > line; unexpected unindent. > > Signed-off-by: Markus

Re: [PATCH] docs: ftrace-uses.rst fix varios code-block directives

On Tue, 12 Dec 2017 11:22:25 +0100 Markus Heiser wrote: > ftrace-uses.rst is not yet included into any toctree, but since it is > a .rst file, it is parsed by the Sphinx build. Thats, why we see some > WARNINGS: > > - trace/ftrace-uses.rst:53: WARNING: Definition list

Re: [PATCH v2] i2c: update i2c-dev.h warning in documentation

On Tue, 12 Dec 2017 19:43:09 +0300 "Cengiz C." wrote: > `Documentation/i2c/dev-interface` gives examples for accessing i2c from > userspace. > > There's a note that warns developers about the two `i2c-dev.h` header > files which were shipped with the kernel and i2c-tools

Re: [PATCH v4 0/3] doc: update printk documentation

On Thu, 21 Dec 2017 11:30:57 -0800 Joe Perches wrote: > > > - There's a dangling reference to printk-formats.txt in lib/vsprintf.c > >that we'll want to fix up. > > patch 1/3 updates that reference. It updates one of them - there were two, one of which remains. I'll

Re: [PATCH 1/1] usb: doc: Update document for USB3 debug port usage

On Wed, 13 Dec 2017 13:07:44 +0800 Lu Baolu wrote: > Update Documentation/driver-api/usb/usb3-debug-port.rst. This update > includes the guide for using xHCI debug capability based TTY serial > link. > > Cc: Mathias Nyman > Cc: Greg

Re: [PATCH 0/3] Documentation: more names to the enforcement statement

On Wed, 13 Dec 2017 13:52:52 +0100 Greg Kroah-Hartman wrote: > Here are 3 patches for the kernel-enforcement-statement file that came > in after the file was originally added to the kernel tree. Applied all three, thanks. jon -- To unsubscribe from this list: send

Re: [PATCH] Documentation/filesystems/vfat.txt: fix a remark that implies UCS2

On Mon, 18 Dec 2017 20:47:27 +0100 Adam Borowski wrote: > All non-historic operating systems support the full range of Unicode here, > thus you can make filenames for example in Gothic (̴̼͉ͅ), the other Gothic > (퓂ℯℴ퓌) or the third Gothic (헆햾허헐), or declare something as . >

Re: [PATCH v4 0/3] doc: update printk documentation

On Wed, 20 Dec 2017 08:17:14 +1100 "Tobin C. Harding" wrote: > This set converts printk-formats.txt -> core-api/printk-formats.rst > > We also update the documentation around printing kernel addresses. > > This is my first documentation conversion. Please do be hard on this >

Re: [PATCH] fixed typo in onewire generic doc

On Tue, 19 Dec 2017 22:33:32 +0100 Gergo Huszty wrote: > Signed-off-by: Gergo Huszty > --- > Documentation/w1/w1.generic | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/w1/w1.generic

Re: device attribute documentation

On Thu, 14 Dec 2017 15:30:13 +0100 (CET) Julia Lawall wrote: [CC += Greg in case he disagrees] > My intern, Aishwarya Pant, is looking into how to improve the > documentation of device attributes. She collected a list of attirbutes > that are not represented anywhere

Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary

On Thu, 7 Dec 2017 23:22:51 + Srinivas Kandagatla wrote: > > It seems you have kerneldoc comments for your data structures and at least > > some of your exported symbols. If you really want to document this stuff > > well, I'd suggest finishing out those

Re: [PATCH] i2c: update i2c-dev.h warning in documentation

On Sat, 9 Dec 2017 23:10:58 +0300 Cengiz Can wrote: > `dev-interface` document gives examples for accessing i2c from > userspace. > > There's a note warning developers about the different `i2c-dev.h` header > files which were shipped with the kernel and i2c-tools separately.

[PATCH] docs: Remove "could not extract kernel version" warning

This warning will happen for every normal kernel docs build and doesn't carry any useful information. Should anybody actually depend on this "version" variable (which isn't clear to me), the "unknown version" value will be clue enough. Signed-off-by: Jonathan Co

Re: [PATCH 0/2] Documentation: Add guidance on CONFIG default value

On Mon, 20 Nov 2017 14:39:32 -0800 Darren Hart wrote: > Document the preference for "default n" in kconfig-language.txt, and reference > that in the submit-checklist.rst. I've (finally) applied the pair to the docs tree, thanks. jon -- To unsubscribe from this list: send

Re: [PATCH 2/2 v2] Documentation: add UUID/GUID to kernel-api

On Wed, 29 Nov 2017 12:32:42 -0800 Randy Dunlap wrote: > From: Randy Dunlap > > Update kernel-doc notation in lib/uuid.c and then add UUID/GUID > function interfaces to kernel-api. > > Signed-off-by: Randy Dunlap Applied

Re: [PATCH 1/2 v2] Documentation: add Sorting section to kernel-api

On Wed, 29 Nov 2017 12:32:38 -0800 Randy Dunlap wrote: > Add sort() and list_sort() to the kernel API documentation in a > new "Sorting" section. > > Signed-off-by: Randy Dunlap Applied to the docs tree, thanks. jon -- To unsubscribe from this

Re: [PATCH 0/2] mux: add overview and add to driver-api docs

On Mon, 11 Dec 2017 09:29:41 +0100 Peter Rosin wrote: > Don't know if this is worth adding, but it might answer at least a few > questions. > > It looks ok when I view the htmldocs output, but I'm not all that certain > this is good to go? Almost, but I have one request: the

Re: [PATCH] docs: refcount_t documentation

On Tue, 5 Dec 2017 12:46:35 +0200 Elena Reshetova wrote: > Some functions from refcount_t API provide different > memory ordering guarantees that their atomic counterparts. > This adds a document outlining these differences ( >

Re: [PATCH] Documentation/driver-api/usb: Replace dead link

On Fri, 8 Dec 2017 01:12:09 +0100 Stefan Tatschner wrote: > This link is dead: > > $ curl -vI http://usb.cs.tum.edu/usbdoc > * Could not resolve host: usb.cs.tum.edu > * Closing connection 0 > curl: (6) Could not resolve host: usb.cs.tum.edu > > I

Re: [PATCH v2] kernel-doc: parse DECLARE_KFIFO and DECLARE_KFIFO_PTR()

On Fri, 8 Dec 2017 09:05:12 -0500 Mauro Carvalho Chehab wrote: > So, teach kernel-doc how to parse DECLARE_KFIFO() and DECLARE_KFIFO_PTR(). > > While here, relax at the past DECLARE_foo() macros, accepting a random > number of spaces after comma. Applied, thanks.

Re: [PATCH] Documentation: kernel-hacking: corrected a typo

On Fri, 8 Dec 2017 19:10:54 +0100 Marco Donato Torsello wrote: > Corrected a typo. > > Signed-off-by: Marco Donato Torsello > --- > Documentation/kernel-hacking/hacking.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-)

Re: [PATCH] doc: convert printk-formats.txt to rst

On Thu, 7 Dec 2017 14:50:42 -0800 Kees Cook wrote: > > +These guides contain general information useful when writing kernel code. > > + > > +.. toctree:: > > + :maxdepth: 1 > > + > > + printk-formats > > I actually think this belongs in the kernel core API

Re: [PATCH v2] doc: convert printk-formats.txt to rst

On Fri, 8 Dec 2017 08:21:09 +1100 "Tobin C. Harding" <m...@tobin.cc> wrote: > Unless I'm a proper wombat that entry is not in the mainline MAINTAINERS > file. Um...from current git... DOCUMENTATION M: Jonathan Corbet <cor...@lwn.net> L: linux-doc@vger.ker

Re: [PATCH v2] doc: convert printk-formats.txt to rst

On Fri, 8 Dec 2017 07:44:34 +1100 "Tobin C. Harding" wrote: > Where is Jon's tree hosted please, I don't see it on kernel.org >From the MAINTAINERS file: T: git git://git.lwn.net/linux.git docs-next jon -- To unsubscribe from this list: send the line "unsubscribe

Re: [PATCH] docs: refcount_t documentation

On Tue, 5 Dec 2017 12:46:35 +0200 Elena Reshetova wrote: > Some functions from refcount_t API provide different > memory ordering guarantees that their atomic counterparts. > This adds a document outlining these differences ( >

Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary

On Thu, 7 Dec 2017 10:27:08 + srinivas.kandaga...@linaro.org wrote: A couple of overall comments... > Documentation/driver-api/index.rst | 1 + > Documentation/driver-api/slimbus/index.rst | 15 > Documentation/driver-api/slimbus/summary.rst | 106 >

Re: [PATCH] doc: convert printk-formats.txt to rst

On Wed, 6 Dec 2017 12:45:29 +1100 "Tobin C. Harding" wrote: > Documentation/printk-formats.txt is a candidate for conversion to > ReStructuredText format. Some effort has already been made to do this > conversion even thought the suffix is currently .txt > > Changes required to

[PULL] Documentation fixes

The following changes since commit 4fbd8d194f06c8a3fd2af1ce560ddb31f7ec8323: Linux 4.15-rc1 (2017-11-26 16:01:47 -0800) are available in the Git repository at: git://git.lwn.net/linux.git tags/docs-4.15-fixes for you to fetch changes up to 9956cfef3409177d9e24ea4b7910148a18073a6f:

Re: [PATCH v3] doc: add maintainer book

On Thu, 30 Nov 2017 12:55:07 +1100 "Tobin C. Harding" <m...@tobin.cc> wrote: > Create a new kernel documentation book 'how to be a maintainer' > (suggested by Jonathan Corbet). Add chapters on 'configuring git' and > 'creating a pull request'. So I've finally gotten aro

<    1   2   3   4   5   6   7   8   >