Re: [PATCH v2] acpi: nfit: document sysfs interface

On Fri, 23 Feb 2018 18:24:48 +0530 Aishwarya Pant wrote: > This is an attempt to document the nfit sysfs interface. The > descriptions have been collected from git commit logs and the ACPI > specification 6.2. Applied to the docs tree, thanks. jon

Re: [PATCH v2] block: rbd: update sysfs interface

On Fri, 23 Feb 2018 15:49:59 +0530 Aishwarya Pant wrote: > The existing sysfs interface has been updated to be in the same format > as described in Documentation/ABI/README. This will be useful for > scripting and tracking changes in the ABI. Attributes have been grouped > by

Re: [PATCH v2] block: rbd: update sysfs interface

On Fri, 23 Feb 2018 15:49:59 +0530 Aishwarya Pant wrote: > The existing sysfs interface has been updated to be in the same format > as described in Documentation/ABI/README. This will be useful for > scripting and tracking changes in the ABI. Attributes have been grouped > by functionality

Re: [trivial PATCH] Documentation/sparse: fix typo

On Tue, 13 Mar 2018 11:10:58 + Eric Engestrom wrote: > If the function enters and exits without the lock held, acquiring and > releasing the lock inside the function in a balanced way, no > -annotation is needed. The tree annotations above are for cases where >

Re: [trivial PATCH] Documentation/sparse: fix typo

On Tue, 13 Mar 2018 11:10:58 + Eric Engestrom wrote: > If the function enters and exits without the lock held, acquiring and > releasing the lock inside the function in a balanced way, no > -annotation is needed. The tree annotations above are for cases where > +annotation is needed. The

Re: [PATCH v2] Documentation/CodingStyle: Add an example for braces

On Thu, 15 Mar 2018 15:04:02 -0500 Gary R Hook wrote: > +Do use braces when a body is more complex than a single simple statement: > + > +.. code-block:: c > + > + if (condition) { > + if (another_condition) > + do_something(); > + }

Re: [PATCH v2] Documentation/CodingStyle: Add an example for braces

On Thu, 15 Mar 2018 15:04:02 -0500 Gary R Hook wrote: > +Do use braces when a body is more complex than a single simple statement: > + > +.. code-block:: c > + > + if (condition) { > + if (another_condition) > + do_something(); > + } Somebody is sure to

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"

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" first, > "this file"

Re: [PATCH 1/2] x86: Force asm-goto

On Tue, 20 Mar 2018 16:50:36 +0100 Peter Zijlstra wrote: > > Given that, how about a patch to Documentation/Changes to reflect the new > > reality? It's not in RST yet, so you should be able to go there without > > ill effect :) > > > That thing says: > > GCC >

Re: [PATCH 1/2] x86: Force asm-goto

On Tue, 20 Mar 2018 16:50:36 +0100 Peter Zijlstra wrote: > > Given that, how about a patch to Documentation/Changes to reflect the new > > reality? It's not in RST yet, so you should be able to go there without > > ill effect :) > > > That thing says: > > GCC > --- > > The gcc

Re: [PATCH 1/2] x86: Force asm-goto

On Mon, 19 Mar 2018 16:41:25 +0100 Peter Zijlstra wrote: > A primary prerequisite for this is of course that the compiler > supports asm-goto. This effecively lifts the minimum GCC version to > build an x86 kernel to gcc-4.5. Given that, how about a patch to

Re: [PATCH 1/2] x86: Force asm-goto

On Mon, 19 Mar 2018 16:41:25 +0100 Peter Zijlstra wrote: > A primary prerequisite for this is of course that the compiler > supports asm-goto. This effecively lifts the minimum GCC version to > build an x86 kernel to gcc-4.5. Given that, how about a patch to Documentation/Changes to reflect the

Re: [PATCH v3 05/11] PCI/P2PDMA: Add P2P DMA driver writer's documentation

On Mon, 12 Mar 2018 13:35:19 -0600 Logan Gunthorpe wrote: > Add a restructured text file describing how to write drivers > with support for P2P DMA transactions. The document describes > how to use the APIs that were added in the previous few > commits. > > Also adds an

Re: [PATCH v3 05/11] PCI/P2PDMA: Add P2P DMA driver writer's documentation

On Mon, 12 Mar 2018 13:35:19 -0600 Logan Gunthorpe wrote: > Add a restructured text file describing how to write drivers > with support for P2P DMA transactions. The document describes > how to use the APIs that were added in the previous few > commits. > > Also adds an index for the PCI

[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

[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 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 sysfs.txt, because > this file

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

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

Re: [PATCH 1/3 RESEND] tpm: add longer timeouts for creation commands.

On Wed, 07 Mar 2018 11:35:03 -0500 Mimi Zohar wrote: > Some maintainers are saying to put the Changelog after the "---" so > that it isn't included in the patch description. > > One of the reasons for including the Changelog in the patch > description, is to credit

Re: [PATCH 1/3 RESEND] tpm: add longer timeouts for creation commands.

On Wed, 07 Mar 2018 11:35:03 -0500 Mimi Zohar wrote: > Some maintainers are saying to put the Changelog after the "---" so > that it isn't included in the patch description. > > One of the reasons for including the Changelog in the patch > description, is to credit people with bug fixes,

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 00/17] Include linux trace docs to Sphinx TOC tree

o 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 6234c7bd8c14508fb76c0a4d6f01eb81c8ce9cbf Mon Sep 17 00:00:00 2001 From: Jonathan Corbet Date: Wed

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 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 Documention/process/submitting-patches.rst

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 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. > > Bugzilla:

Re: [PATCH 1/3 RESEND] tpm: add longer timeouts for creation commands.

On Tue, 06 Mar 2018 13:36:36 -0500 Mimi Zohar wrote: > I've heard that some maintainers are moving away from cover letters, > since they are not include in the git repo and are lost. If I get a patch series with a cover letter that should be preserved, I apply the

Re: [PATCH 1/3 RESEND] tpm: add longer timeouts for creation commands.

On Tue, 06 Mar 2018 13:36:36 -0500 Mimi Zohar wrote: > I've heard that some maintainers are moving away from cover letters, > since they are not include in the git repo and are lost. If I get a patch series with a cover letter that should be preserved, I apply the series in a branch then do a

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

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

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

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

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] 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: Aishwarya Pant

Re: [PATCH v2 0/3] backlight: document sysfs interfaces

On Tue, 6 Feb 2018 13:08:41 +0530 Aishwarya Pant wrote: > Patchset contains documentation of the sysfs interfaces for the > following five backlight drivers- > 1) lm3639 > 2) adp5520 > 3) adp8860 > > It was compiled from data sheets, reading code and git history logs. In v2

Re: [PATCH v2 0/3] backlight: document sysfs interfaces

On Tue, 6 Feb 2018 13:08:41 +0530 Aishwarya Pant wrote: > Patchset contains documentation of the sysfs interfaces for the > following five backlight drivers- > 1) lm3639 > 2) adp5520 > 3) adp8860 > > It was compiled from data sheets, reading code and git history logs. In v2 of > the patches,

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 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 except > for LKML. I am guessing linux-block

Re: [PATCH v5] Documentation/ABI: update infiniband sysfs interfaces

On Sat, 10 Feb 2018 13:11:04 +0530 Aishwarya Pant wrote: > Add documentation for core and hardware specific infiniband interfaces. > The descriptions have been collected from git commit logs, reading > through code and data sheets. Some drivers have incomplete doc and are >

Re: [PATCH v5] Documentation/ABI: update infiniband sysfs interfaces

On Sat, 10 Feb 2018 13:11:04 +0530 Aishwarya Pant wrote: > Add documentation for core and hardware specific infiniband interfaces. > The descriptions have been collected from git commit logs, reading > through code and data sheets. Some drivers have incomplete doc and are > annotated with the

Re: [PATCH v3] aoe: document sysfs interface

On Mon, 19 Feb 2018 23:46:53 +0530 Aishwarya Pant wrote: > Documentation has been compiled from git commit logs and descriptions in > Documentation/aoe/aoe.txt. This should be useful for scripting and > tracking changes in the ABI. > > Signed-off-by: Aishwarya Pant

Re: [PATCH v3] aoe: document sysfs interface

On Mon, 19 Feb 2018 23:46:53 +0530 Aishwarya Pant wrote: > Documentation has been compiled from git commit logs and descriptions in > Documentation/aoe/aoe.txt. This should be useful for scripting and > tracking changes in the ABI. > > Signed-off-by: Aishwarya Pant Applied to the docs tree,

Re: [RESEND PATCH v2] Documentation/ABI: add sysfs interface for s6e63m0 lcd driver

On Fri, 23 Feb 2018 18:53:52 +0530 Aishwarya Pant wrote: > Document sysfs attributes of s6e63m0 lcd panel driver by looking through > git logs and reading code. > > Signed-off-by: Aishwarya Pant Applied, thanks. jon

Re: [RESEND PATCH v2] Documentation/ABI: add sysfs interface for s6e63m0 lcd driver

On Fri, 23 Feb 2018 18:53:52 +0530 Aishwarya Pant wrote: > Document sysfs attributes of s6e63m0 lcd panel driver by looking through > git logs and reading code. > > Signed-off-by: Aishwarya Pant Applied, thanks. jon

Re: [RESEND PATCH v2] Documentation/ABI: clean up sysfs-class-pktcdvd

On Fri, 23 Feb 2018 18:46:32 +0530 Aishwarya Pant wrote: > Clean up the sysfs documentation such that it is in the same format as > described in Documentation/ABI/README. Mainly, the patch moves the > attribute names to the 'What:' field. This might be useful for scripting >

Re: [RESEND PATCH v2] Documentation/ABI: clean up sysfs-class-pktcdvd

On Fri, 23 Feb 2018 18:46:32 +0530 Aishwarya Pant wrote: > Clean up the sysfs documentation such that it is in the same format as > described in Documentation/ABI/README. Mainly, the patch moves the > attribute names to the 'What:' field. This might be useful for scripting > and tracking changes

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] 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. > > Signed-off-by: Mike

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] 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 documented > list of

Re: [PATCH 1/6] genalloc: track beginning of allocations

On Wed, 21 Feb 2018 14:29:06 -0800 Kees Cook wrote: > >> I wonder if this might be more readable by splitting the kernel-doc > >> changes from the bitmap changes? I.e. fix all the kernel-doc in one > >> patch, and in the following, make the bitmap changes. Maybe it's such

Re: [PATCH 1/6] genalloc: track beginning of allocations

On Wed, 21 Feb 2018 14:29:06 -0800 Kees Cook wrote: > >> I wonder if this might be more readable by splitting the kernel-doc > >> changes from the bitmap changes? I.e. fix all the kernel-doc in one > >> patch, and in the following, make the bitmap changes. Maybe it's such > >> a small part that

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

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

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: [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: [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: [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 marks around G and P.

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 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 example about how to use

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] 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/ Well...one wouldn't want to

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 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 why you're > > wanting to

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] 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 match for identifier

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] 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. jon

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

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 available, and (2)

[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

[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 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

[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 Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 21 - 1 file changed, 16 insertions(+), 5 deletions

[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 2/8] docs: kernel-doc: Rename and split STATE_FIELD

process_file() splitup easier. Reviewed-by: Jani Nikula Signed-off-by: Jonathan Corbet --- 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

[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 Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 137 - 1 file changed, 72 insertions(+), 65 deletions(-) diff --git

[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 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 Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 193 - 1 file changed, 101 insertions(+), 92 deletions(-) diff --git a/scripts/kernel-doc b

[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 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 Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 46 -- 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/scripts/kernel-doc b/scripts

[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 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 --- scripts/kernel-doc | 69 ++ 1 file changed, 64 insertions(+), 5 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index fb8fbdb25036.

[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 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 Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 139

[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 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 --- scripts/kernel-doc | 65

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

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

Re: [PATCH 5/6] Documentation for Pmalloc

On Fri, 9 Feb 2018 19:37:14 -0800 Matthew Wilcox wrote: > I've done this as the first line of my new documentation files: > > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > I think this is the CC license that's closest in spirit to the GPL without > the unintended

Re: [PATCH 5/6] Documentation for Pmalloc

On Fri, 9 Feb 2018 19:37:14 -0800 Matthew Wilcox wrote: > I've done this as the first line of my new documentation files: > > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > I think this is the CC license that's closest in spirit to the GPL without > the unintended consequences of the GPL when

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 1/8] docs: kernel-doc: Get rid of xml_escape() and friends

On Fri, 09 Feb 2018 11:09:27 +0200 Jani Nikula wrote: > On Wed, 07 Feb 2018, Jonathan Corbet wrote: > > 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() > >

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

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 worth fixing up

[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/

<    6   7   8   9   10   11   12   13   14   15   >