Re: [PATCH] Documentation: LSM: Correct the basic LSM description

2020-04-28 Thread Jonathan Corbet
On Tue, 21 Apr 2020 14:48:34 -0700 Casey Schaufler wrote: > This is a first pass at updating the basic documentation on > Linux Security Modules (LSM), which is frighteningly out of date. > Remove untrue statements about the LSM framework. Replace them > with true statements where it is

Re: [PATCH 2/3] docs: sysctl/kernel: document ftrace entries

2020-04-28 Thread Jonathan Corbet
On Thu, 23 Apr 2020 20:36:50 +0200 Stephen Kitt wrote: > Based on the ftrace documentation, the tp_printk boot parameter > documentation, and the implementation in kernel/trace/trace.c. > > Signed-off-by: Stephen Kitt This one could benefit from an ack from Steve (CC'd). Also one other

Re: [PATCH 1/3] docs: sysctl/kernel: document cad_pid

2020-04-28 Thread Jonathan Corbet
On Thu, 23 Apr 2020 20:36:49 +0200 Stephen Kitt wrote: > Based on the implementation in kernel/sysctl.c (the proc_do_cad_pid() > function), kernel/reboot.c, and include/linux/sched/signal.h. > > Signed-off-by: Stephen Kitt > --- > Documentation/admin-guide/sysctl/kernel.rst | 10 ++ >

Re: [PATCH] docs: virt/kvm: close inline string literal

2020-04-28 Thread Jonathan Corbet
On Fri, 24 Apr 2020 17:26:37 +0200 Stephen Kitt wrote: > This fixes > > Documentation/virt/kvm/amd-memory-encryption.rst:76: WARNING: Inline > literal start-string without end-string. > > Fixes: 2da1ed62d55c ("KVM: SVM: document KVM_MEM_ENCRYPT_OP, let userspace > detect if SEV is

Re: [PATCH 1/1] mailmap: Add entry for Leonardo Bras

2020-04-28 Thread Jonathan Corbet
On Mon, 27 Apr 2020 23:44:40 -0300 Leonardo Bras wrote: > Add an entry to connect my email addresses. > > Signed-off-by: Leonardo Bras > --- > .mailmap | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/.mailmap b/.mailmap > index db3754a41018..4600dcfed0d3 100644 > --- a/.mailmap >

Re: [PATCH] Documentation: x86: fix space instead of tab in uefi doc

2020-04-28 Thread Jonathan Corbet
On Tue, 28 Apr 2020 15:32:25 +0200 Flavio Suligoi wrote: > Signed-off-by: Flavio Suligoi > --- > Documentation/x86/x86_64/uefi.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/x86/x86_64/uefi.rst > b/Documentation/x86/x86_64/uefi.rst > index

Re: [PATCH] mm/gup.c: Updating the documentation

2020-04-28 Thread Jonathan Corbet
On Mon, 27 Apr 2020 12:26:06 -0700 Andrew Morton wrote: > On Tue, 28 Apr 2020 00:23:50 +0530 Souptick Joarder > wrote: > > > This patch is an attempt to update the documentation. > > > > * Adding / removing extra * based on type of function > > static / global. > > I don't think so,

Re: [PATCH] Updated iostats docs

2019-10-18 Thread Jonathan Corbet
On Wed, 16 Oct 2019 22:13:37 +0200 Albert Vaca Cintora wrote: > revious docs mentioned 11 unsigned long fields, when the reality is that > we have 15 fields with a mix of unsigned long and unsigned int. > > Signed-off-by: Albert Vaca Cintora > --- > Documentation/admin-guide/iostats.rst | 47

Re: [PATCH 1/3] docs: fix some broken references

2019-10-10 Thread Jonathan Corbet
On Tue, 24 Sep 2019 10:01:28 -0300 Mauro Carvalho Chehab wrote: > There are a number of documentation files that got moved or > renamed. update their references. > > Signed-off-by: Mauro Carvalho Chehab I've applied this set, thanks. jon

[PATCH 0/2] docs: move the ioctl() documentation out of the top level

2019-10-03 Thread Jonathan Corbet
to the userspace-api book along with the rest of the user-space documentation. Jonathan Corbet (2): docs: move botching-up-ioctls.rst to the process guide docs: Move the user-space ioctl() docs to userspace-api Documentation/index.rst| 1 - Documentation

Re: [PATCH] Documentation: networking: device drivers: Remove stray asterisks

2019-10-03 Thread Jonathan Corbet
On Wed, 2 Oct 2019 17:09:55 +0200 Jonathan Neuschäfer wrote: > These asterisks were once references to a line that said: > "* Other names and brands may be claimed as the property of others." > But now, they serve no purpose; they can only irritate the reader. > > Fixes: de3edab4276c

Re: [PATCH 0/2] docs: Programmatically render MAINTAINERS into ReST

2019-10-01 Thread Jonathan Corbet
On Tue, 24 Sep 2019 16:02:06 -0700 Kees Cook wrote: > Commit log from Patch 2 repeated here for cover letter: > > In order to have the MAINTAINERS file visible in the rendered ReST > output, this makes some small changes to the existing MAINTAINERS file > to allow for better machine processing,

Re: [PATCH v2 2/3] Maintainer Handbook: Maintainer Entry Profile

2019-10-01 Thread Jonathan Corbet
On Wed, 11 Sep 2019 08:48:54 -0700 Dan Williams wrote: > As presented at the 2018 Linux Plumbers conference [1], the Maintainer > Entry Profile (formerly Subsystem Profile) is proposed as a way to reduce > friction between committers and maintainers and encourage conversations > amongst

Re: [PATCH v2] scripts/sphinx-pre-install: add how to exit virtualenv usage message

2019-10-01 Thread Jonathan Corbet
On Wed, 18 Sep 2019 18:37:54 -0600 Shuah Khan wrote: > Add usage message on how to exit the virtualenv after documentation > work is done. > > Signed-off-by: Shuah Khan > --- > Changes since v1: > Changed the message based on Mauro's review comments. Applied, thanks. jon

Re: [PATCH 2/2] docs: security: update base LSM documentation file

2019-10-01 Thread Jonathan Corbet
On Wed, 25 Sep 2019 13:06:28 -0700 Kees Cook wrote: > > +always appears first in the stack of LSM hooks. A > > +:c:func:`security_add_hooks()` function (in ``security/security.c``) > > IIUC, the :c:func:`...()` marking isn't needed any more, just having a > word followed by "()" should

Re: [PATCH 1/2] mailmap: add new email address for Martin Kepplinger

2019-10-01 Thread Jonathan Corbet
On Tue, 24 Sep 2019 08:28:02 +0200 Martin Kepplinger wrote: > Include my new email address for tracking my contributions. > > Signed-off-by: Martin Kepplinger Applied, thanks (and the CREDITS patch too). jon

Re: [GIT PULL] remove dead mutt url and add active mutt url

2019-09-30 Thread Jonathan Corbet
On Sat, 28 Sep 2019 20:43:03 +0530 Bhaskar Chowdhury wrote: > The following changes since commit 4e4327891fe2a2a4db342985bff4d4c48703c707: > > replace dead mutt url with active one. (2019-09-28 20:11:00 +0530) > > are available in the Git repository at: Bhaskar, I'm not going to take a

Re: [GIT PULL] Thermal management updates for v5.4-rc1

2019-09-30 Thread Jonathan Corbet
On Fri, 27 Sep 2019 15:29:47 -0400 Doug Ledford wrote: > If you are doing linux kernel development, and you are doing a rebase, > please read Documentation/When_Not_To_Rebase.rst before rebasing your > code and sending it to Linus. You've been warned. For anybody following along at home, the

Re: [PATCH V2] Remove dead url and added active url .

2019-09-28 Thread Jonathan Corbet
On Fri, 27 Sep 2019 20:14:11 +0530 Bhaskar Chowdhury wrote: > diff --git a/Documentation/process/email-clients.rst > b/Documentation/process/email-clients.rst > index 1f920d445a8b..15781bf10b8d 100644 > --- a/Documentation/process/email-clients.rst > +++

Re: [PATCH] reap out the dead mutt config links

2019-09-27 Thread Jonathan Corbet
On Fri, 27 Sep 2019 11:10:13 +0530 Bhaskar Chowdhury wrote: > Signed-off-by: Bhaskar Chowdhury > --- > Documentation/process/email-clients.rst | 5 - > 1 file changed, 5 deletions(-) > > diff --git a/Documentation/process/email-clients.rst > b/Documentation/process/email-clients.rst >

Re: [Ksummit-discuss] [PATCH v2 3/3] libnvdimm, MAINTAINERS: Maintainer Entry Profile

2019-09-13 Thread Jonathan Corbet
On Wed, 11 Sep 2019 16:11:29 -0600 Jens Axboe wrote: > On 9/11/19 12:43 PM, Dan Carpenter wrote: > > > > I kind of hate all this extra documentation because now everyone thinks > > they can invent new hoops to jump through. > > FWIW, I completely agree with Dan (Carpenter) here. I absolutely

Re: [PATCH] mailmap: Update email address for Quentin Perret

2019-09-06 Thread Jonathan Corbet
On Fri, 6 Sep 2019 10:22:47 +0100 Will Deacon wrote: > > If there's some value to having an entry in the mailmap file, then > > obviously it should be added. I didn't resist so much as engage in a > > little muttering under my breath as I applied the patch... > > Ok, just wanted to make sure

Re: [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts

2019-09-05 Thread Jonathan Corbet
On Thu, 5 Sep 2019 06:23:13 -0300 Mauro Carvalho Chehab wrote: > Python's PEP-263 [1] dictates that an script that needs to default to > UTF-8 encoding has to follow this rule: > > 'Python will default to ASCII as standard encoding if no other >encoding hints are given. > >

Re: [PATCH] mailmap: Update email address for Quentin Perret

2019-09-04 Thread Jonathan Corbet
On Tue, 3 Sep 2019 15:59:50 +0100 Will Deacon wrote: > Since this isn't really an arm64 change (there's no change to MAINTAINERS), > I'd rather it went via Andrew or Jon. However, there was some resistance > last time this sort of email change happened: > >

Re: [PATCH] mailmap: Add an entry for my email address

2019-08-06 Thread Jonathan Corbet
On Thu, 1 Aug 2019 20:26:03 +0300 Todor Tomov wrote: > My @linaro.org email address doesn't exist anymore so add a > mailmap entry to map it to my @gmail.com address. > > Signed-off-by: Todor Tomov I've applied this, but I'm still not convinced that all of these .mailmap entries are really

Re: [PATCH] Documentation/checkpatch: Prefer str_has_prefix over strncmp

2019-08-02 Thread Jonathan Corbet
On Fri, 2 Aug 2019 14:25:37 +0800 Chuhong Yuan wrote: > Add strncmp() to Documentation/process/deprecated.rst since > using strncmp() to check whether a string starts with a > prefix is error-prone. > The safe replacement is str_has_prefix(). Is that the *only* use of strncmp()? > Also add

Re: [PATCH] mailmap: add entry for Jaegeuk Kim

2019-08-02 Thread Jonathan Corbet
On Fri, 2 Aug 2019 09:21:35 +0800 Chao Yu wrote: > Add entry to connect all Jaegeuk's email addresses. > > Acked-by: Jaegeuk Kim > Signed-off-by: Chao Yu > --- > .mailmap | 3 +++ > 1 file changed, 3 insertions(+) > > diff --git a/.mailmap b/.mailmap > index 477debe3d960..70d41c86e644

Re: [PATCH] MAINTAINERS: add entries for some documentation scripts

2019-07-26 Thread Jonathan Corbet
On Fri, 26 Jul 2019 11:52:34 -0300 Mauro Carvalho Chehab wrote: > There are some documentation scripts I wrote with doesn't > have any maintainer at maintainer's file. > > Add them to the DOCUMENTATION entry, in order to have > Jon and linux-doc ML c/c on those patches, plus a new > entry to

Re: [PATCH] checkpatch: Added warnings in favor of strscpy().

2019-07-22 Thread Jonathan Corbet
On Mon, 22 Jul 2019 15:24:33 -0700 Joe Perches wrote: > > If the functions themselves are fully defined in the .h file, I'd just add > > the kerneldoc there as well. That's how it's usually done, and you want > > to keep the documentation and the prototypes together. > > In this case, it's a

Re: [PATCH] checkpatch: Added warnings in favor of strscpy().

2019-07-22 Thread Jonathan Corbet
On Mon, 22 Jul 2019 14:50:09 -0700 Joe Perches wrote: > On Mon, 2019-07-22 at 23:01 +0200, Stephen Kitt wrote: > > How about you submit your current patch set, and I follow up with the above > > adapted to stracpy? > > OK, I will shortly after I figure out how to add kernel-doc > for

Re: [PATCH 1/2] doc:it_IT: align translation to mainline

2019-07-22 Thread Jonathan Corbet
On Thu, 18 Jul 2019 09:47:24 +0200 Federico Vaga wrote: > The patch translates the following patches in Italian: > > d9d7c0c497b8 docs: Note that :c:func: should no longer be used > 83e8b971f81c sphinx.rst: Add note about code snippets embedded in the text > cca5e0b8a430 Documentation: PGP:

Re: [PATCH V2 1/1 (was 0/1 by accident)] tools/dtrace: initial implementation of DTrace

2019-07-10 Thread Jonathan Corbet
On Wed, 10 Jul 2019 21:32:25 +0200 Daniel Borkmann wrote: > Looks like you missed Brendan Gregg's prior feedback from v1 [0]. I haven't > seen a strong compelling argument for why this needs to reside in the kernel > tree given we also have all the other tracing tools and many of which also >

Re: [PATCH v2] docs: driver-api: generic-counter: fix file path to ABI doc

2019-07-09 Thread Jonathan Corbet
On Tue, 9 Jul 2019 20:06:33 +0900 William Breathitt Gray wrote: > Fixes: 09e7d4ed8991 ("docs: Add Generic Counter interface documentation") > Signed-off-by: William Breathitt Gray > > Jonathan, would you be able to pick this up in your tree? I can apply it, yes. But why are you supplying an

Re: [PATCH] docs: format kernel-parameters -- as code

2019-06-28 Thread Jonathan Corbet
On Fri, 28 Jun 2019 20:38:41 +0200 Stephen Kitt wrote: > Right, looking further shows a large number of places where -- is handled > incorrectly. The following patch disables this “smart” handling wholesale; > I’ll follow up (in the next few days) with patches to use real em- and > en-dashes

Re: linux-next: Signed-off-by missing for commit in the jc_docs tree

2019-06-26 Thread Jonathan Corbet
On Thu, 27 Jun 2019 08:01:23 +1000 Stephen Rothwell wrote: > Commit > > fad3d54ef8a8 ("Documentation: PGP: update for newer HW devices") > > is missing a Signed-off-by from its committer. Argh. I had to jump through some hoops to apply that patch and ... screwed up. Thanks, jon

Re: [PATCH] docs: zh_CN: submitting-drivers.rst: Remove a duplicated Documentation/

2019-06-26 Thread Jonathan Corbet
On Sat, 22 Jun 2019 14:47:46 -0300 Mauro Carvalho Chehab wrote: > Somehow, this file ended with Documentation/ twice. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/translations/zh_CN/process/submitting-drivers.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > >

Re: [PATCH v6] Documentation: Add section about CPU vulnerabilities for Spectre

2019-06-26 Thread Jonathan Corbet
On Thu, 20 Jun 2019 16:10:50 -0700 Tim Chen wrote: > Add documentation for Spectre vulnerability and the mitigation mechanisms: > > - Explain the problem and risks > - Document the mitigation mechanisms > - Document the command line controls > - Document the sysfs files > > Co-developed-by:

[PATCH v3 1/4] Docs: An initial automarkup extension for sphinx

2019-06-26 Thread Jonathan Corbet
Rather than fill our text files with :c:func:`function()` syntax, just do the markup via a hook into the sphinx build process. Signed-off-by: Jonathan Corbet --- Documentation/conf.py | 3 +- Documentation/sphinx/automarkup.py | 93 ++ 2 files changed

[PATCH v3 4/4] docs: Note that :c:func: should no longer be used

2019-06-26 Thread Jonathan Corbet
Now that we can mark up function() automatically, there is no reason to use :c:func: and every reason to avoid it. Adjust the documentation to reflect that fact. Signed-off-by: Jonathan Corbet --- Documentation/doc-guide/sphinx.rst | 13 - 1 file changed, 8 insertions(+), 5

Re: [PATCH 3/6] lib: list_sort.c: add a blank line to avoid kernel-doc warnings

2019-06-20 Thread Jonathan Corbet
On Tue, 18 Jun 2019 15:51:19 -0300 Mauro Carvalho Chehab wrote: > In order for a list to be recognized as such, blank lines > are required. > > Solve those Sphinx warnings: > > ./lib/list_sort.c:162: WARNING: Unexpected indentation. > ./lib/list_sort.c:163: WARNING: Block quote ends without a

Re: [PATCH] docs/vm: hwpoison.rst: Fix quote formatting

2019-06-18 Thread Jonathan Corbet
On Tue, 18 Jun 2019 15:56:05 +0100 Valentin Schneider wrote: > The asterisks prepended to the quoted text currently get translated to > bullet points, which gets increasingly confusing the smaller your > screen is (when viewing the sphinx output, that is). > > Convert the whole quote to a

Re: [PATCH v3] Documentation: Add section about CPU vulnerabilities for Spectre

2019-06-17 Thread Jonathan Corbet
On Mon, 17 Jun 2019 22:21:51 +0200 (CEST) Thomas Gleixner wrote: > > +Spectre variant 1 attacks take advantage of speculative execution of > > +conditional branches, while Spectre variant 2 attacks use speculative > > +execution of indirect branches to leak privileged memory. See [1] [5] > >

Re: [PATCH v2] Documentation: coresight: Update the generic device names

2019-06-14 Thread Jonathan Corbet
On Tue, 11 Jun 2019 09:57:57 -0600 Mathieu Poirier wrote: > This looks goo do me. Jonathan, if you prefer to handle this via your tree: > > Reviewed-by: Mathieu Poirier > > Otherwise I'll pick it up. I've applied it, thanks. jon

Re: [PATCH] sphinx.rst: Add note about code snippets embedded in the text

2019-06-14 Thread Jonathan Corbet
On Tue, 11 Jun 2019 17:03:16 -0300 André Almeida wrote: > There's a paragraph that explains how to create fixed width text block, > but it doesn't explains how to create fixed width text inline, although > this feature is really used through the documentation. Fix that adding a > quick note

Re: [PATCH] scripts/documentation-file-ref-check: ignore output dir

2019-06-14 Thread Jonathan Corbet
On Thu, 13 Jun 2019 07:29:17 -0300 Mauro Carvalho Chehab wrote: > When there's no Documentation/output directory, the script will > complain about those missing references: > > Documentation/doc-guide/sphinx.rst: Documentation/output > Documentation/doc-guide/sphinx.rst:

Re: [PATCH v4 14/28] docs: locking: convert docs to ReST and rename to *.rst

2019-06-14 Thread Jonathan Corbet
On Wed, 12 Jun 2019 14:52:50 -0300 Mauro Carvalho Chehab wrote: > Convert the locking documents to ReST and add them to the > kernel development book where it belongs. > > Most of the stuff here is just to make Sphinx to properly > parse the text file, as they're already in good shape, > not

Re: [PATCH v4 00/28] Convert files to ReST - part 1

2019-06-14 Thread Jonathan Corbet
On Wed, 12 Jun 2019 14:52:36 -0300 Mauro Carvalho Chehab wrote: > This is mostly a rebase of the /33 series v3 I sent, on the top of the latest > linux-next (next-20190612). > > Changes from v3: > > - dropped cpufreq conversion - documents are too outdated; > - infiniband patch is not here

Re: [PATCH v4 02/28] docs: arm64: convert docs to ReST and rename to .rst

2019-06-14 Thread Jonathan Corbet
On Fri, 14 Jun 2019 14:10:41 -0600 Jonathan Corbet wrote: > On Wed, 12 Jun 2019 14:52:38 -0300 > Mauro Carvalho Chehab wrote: > > > The documentation is in a format that is very close to ReST format. > > > > The conversion is actually: > > - add blank line

Re: Documentation: Remove duplicate x86 index entry

2019-06-14 Thread Jonathan Corbet
On Fri, 14 Jun 2019 09:02:49 +0200 (CEST) Thomas Gleixner wrote: > x86 got added twice to the index via the RST conversion and the MDS > documentation changes. Remove one instance. > > Signed-off-by: Thomas Gleixner > --- > Documentation/index.rst |1 - > 1 file changed, 1 deletion(-) >

Re: [PATCH 06/13] keys: Add a notification facility [ver #4]

2019-06-10 Thread Jonathan Corbet
On Fri, 07 Jun 2019 15:18:19 +0100 David Howells wrote: > Add a key/keyring change notification facility whereby notifications about > changes in key and keyring content and attributes can be received. > > Firstly, an event queue needs to be created: > > fd = open("/dev/event_queue",

Re: [PATCH 5.1 56/85] doc: Cope with the deprecation of AutoReporter

2019-06-10 Thread Jonathan Corbet
On Mon, 10 Jun 2019 09:48:40 +0200 Greg Kroah-Hartman wrote: > Hm, 2.1 here: > Running Sphinx v2.1.0 > perhaps Tumbleweed needs to update? :) Heh...trying 2.1 is still on my list of things to do ... :) > Anyway, this should not be breaking, if Jon doesn't have any ideas, I'll > just

Re: [PATCH] scripts/sphinx-pre-install: fix "dependenties" typo

2019-06-07 Thread Jonathan Corbet
On Thu, 30 May 2019 16:59:14 -0500 Bjorn Helgaas wrote: > From: Bjorn Helgaas > > Fix typo ("dependenties" for "dependencies"). > > Signed-off-by: Bjorn Helgaas > --- > scripts/sphinx-pre-install | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git

Re: [PATCH] docs: filesystems: vfs: Render method descriptions

2019-06-06 Thread Jonathan Corbet
ame. > > Suggested-by: Jonathan Corbet > Signed-off-by: Tobin C. Harding > --- > > Jon, > > As discussed on LKML; this patch applies on top of the series > > [PATCH v4 0/9] docs: Convert VFS doc to RST > > If it does not apply cleanly to your branch pleas

[PATCH] Generic radix trees: fix kerneldoc comment

2019-05-24 Thread Jonathan Corbet
-by: Jonathan Corbet --- include/linux/generic-radix-tree.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/linux/generic-radix-tree.h b/include/linux/generic-radix-tree.h index 3a91130a4fbd..02393c0c98f9 100644 --- a/include/linux/generic-radix-tree.h +++ b/include/linux/generic

Re: [PATCH 0/8] docs: Fixes for recent versions of Sphinx

2019-05-23 Thread Jonathan Corbet
On Thu, 23 May 2019 07:38:30 -0300 Mauro Carvalho Chehab wrote: > It seems that this message is there since 1.8: > > https://www.sphinx-doc.org/en/1.8/_modules/sphinx/application.html ...which is strange, since I didn't see it until I built with 2.0. It was annoying to see a new

[PATCH 0/8] docs: Fixes for recent versions of Sphinx

2019-05-22 Thread Jonathan Corbet
() - Fix a few build errors - Add Mauro's sphinx-pre-install improvements Jonathan Corbet (7): doc: Cope with Sphinx logging deprecations doc: Cope with the deprecation of AutoReporter docs: fix numaperf.rst and add it to the doc tree lib/list_sort: fix kerneldoc build error docs: fix

[PATCH 2/8] doc: Cope with the deprecation of AutoReporter

2019-05-22 Thread Jonathan Corbet
. But switch_source_input() only showed up in 1.7, so we have to do ugly version checks to keep things working in older versions. Signed-off-by: Jonathan Corbet --- Documentation/sphinx/kerneldoc.py | 34 +++ 1 file changed, 26 insertions(+), 8 deletions(-) diff --git

[PATCH 4/8] lib/list_sort: fix kerneldoc build error

2019-05-22 Thread Jonathan Corbet
Unexpected indentation. ./lib/list_sort.c:162: WARNING: Block quote ends without a blank line; unexpected unindent. Fix the offending literal block and make the error go away. Fixes: 043b3f7b6388 ("lib/list_sort: simplify and remove MAX_LIST_LENGTH_BITS") Cc: George Spelvin Signed-off

[PATCH 8/8] scripts/sphinx-pre-install: make it handle Sphinx versions

2019-05-22 Thread Jonathan Corbet
-by: Jonathan Corbet --- scripts/sphinx-pre-install | 81 ++ 1 file changed, 74 insertions(+), 7 deletions(-) diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install index f6a5c0bae31e..e667db230d0a 100755 --- a/scripts/sphinx-pre-install +++ b/scripts

[PATCH 3/8] docs: fix numaperf.rst and add it to the doc tree

2019-05-22 Thread Jonathan Corbet
Cc: Keith Busch Cc: Mike Rapoport Signed-off-by: Jonathan Corbet --- Documentation/admin-guide/mm/index.rst| 1 + Documentation/admin-guide/mm/numaperf.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guid

Re: linux-next: Fixes tag needs some work in the jc_docs tree

2019-05-21 Thread Jonathan Corbet
On Tue, 21 May 2019 20:52:46 +0200 Sven Eckelmann wrote: > > I'm hoping that's meant to be a joke...? This is certainly not a big > > problem on any scale... > > Not really. If you are so frustrated that you start your reply with "" > then I think that it was not enough for me to explain

Re: linux-next: Fixes tag needs some work in the jc_docs tree

2019-05-21 Thread Jonathan Corbet
On Tue, 21 May 2019 20:23:48 +0200 Sven Eckelmann wrote: > > > > It is ok, I will never send you any patch again. I'm hoping that's meant to be a joke...? This is certainly not a big problem on any scale... jon

Re: linux-next: Fixes tag needs some work in the jc_docs tree

2019-05-21 Thread Jonathan Corbet
On Tue, 21 May 2019 09:18:21 +0200 Sven Eckelmann wrote: > On Monday, 20 May 2019 23:54:23 CEST Jonathan Corbet wrote: > [...] > > Argh, sorry, I should have caught that. Fixed, thanks. > > Thanks for trying. Unfortunately it was changed to the wrong value. The > actu

Re: linux-next: Fixes tag needs some work in the jc_docs tree

2019-05-20 Thread Jonathan Corbet
On Tue, 21 May 2019 07:44:35 +1000 Stephen Rothwell wrote: > In commit > > 9eaa65e8aad5 ("scripts/spdxcheck.py: Add dual license subdirectory") > > Fixes tag > > Fixes: 99871f2f9a4d ("scripts/spdxcheck.py: Fix path to deprecated > licenses") > > has these problem(s): > > - Target

Re: [PATCH] scripts/spdxcheck.py: Fix path to deprecated licenses

2019-05-20 Thread Jonathan Corbet
On Sat, 11 May 2019 22:19:16 +0200 Sven Eckelmann wrote: > The directory name for other licenses was changed to "deprecated" in > commit 62be257e986d ("LICENSES: Rename other to deprecated"). But it was > not changed for spdxcheck.py. As result, checkpatch failed with Both patches applied,

Re: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit

2019-05-15 Thread Jonathan Corbet
On Tue, 14 May 2019 16:19:02 -0700 Brendan Higgins wrote: > Hmmm...probably premature to bring this up, but Documentation/dev-tools/ > is kind of thrown together. Wait a minute, man... *I* created that directory, are you impugning my work? :) But yes, "kind of thrown together" is a good

Re: https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/mds.html gives 404

2019-05-14 Thread Jonathan Corbet
On Tue, 14 May 2019 19:48:12 +0200 Toralf Förster wrote: > But this link is mentioned in dmesg of 5.1.2 It works for me. I think you just needed to wait for the relevant commit to make it upstream and the docs to be regenerated. Thanks, jon

[GIT PULL] Some more documentation work for 5.2

2019-05-10 Thread Jonathan Corbet
): doc:it_IT: align documentation after licenses patches Jonathan Corbet (1): Merge branch 'x86' into docs-next Tzvetomir Stoyanov (1): Documentation/trace: Add clarification how histogram onmatch works Documentation/index.rst| 1 + Documentation/trace

Re: GFS2: Pull Request

2019-05-08 Thread Jonathan Corbet
On Wed, 8 May 2019 22:17:12 +0200 Andreas Gruenbacher wrote: > Would it make sense to describe how to deal with merge conflicts in > Documentation/maintainer/pull-requests.rst to stop people from getting > this wrong over and over again? I think this certainly belongs in the maintainer manual,

Re: [PATCH v2] Documentation/trace: Add clarification how histogram onmatch works

2019-05-08 Thread Jonathan Corbet
On Wed, 8 May 2019 12:18:54 -0400 Steven Rostedt wrote: > Jon, > > Can you take this patch in your tree? Will do. jon

Re: [PATCH] scripts/documentation-file-ref-check: detect broken :doc:`foo`

2019-05-03 Thread Jonathan Corbet
On Wed, 24 Apr 2019 13:25:33 -0300 Mauro Carvalho Chehab wrote: > As we keep migrating documents to ReST, we're starting to see > more of such tags. > > Right now, all such tags are pointing to a documentation file, > but regressions may be introduced. > > So, add a check for such kind of

Re: [PATCH] scripts/documentation-file-ref-check: don't parse Next/ dir

2019-05-03 Thread Jonathan Corbet
On Mon, 22 Apr 2019 08:42:02 -0300 Mauro Carvalho Chehab wrote: > If one tries to run this script under linux-next, it would > hit lots of false-positives, due to the tree merges that > are stored under the Next/ directory. > > So, add a logic to ignore it. > > Signed-off-by: Mauro Carvalho

Re: [RFC PATCH 3/5] kobject: Fix kernel-doc comment first line

2019-05-03 Thread Jonathan Corbet
On Thu, 2 May 2019 18:46:16 -0700 Randy Dunlap wrote: > I have seen this discussion before also. And sometimes it is not even > a discussion -- it's more of an edict. To which I object/disagree. > The current (or past) comment style is perfectly fine IMO. > No caps needed. No ending '.'

Re: [PATCH 1/2] Docs: An initial automarkup extension for sphinx

2019-04-26 Thread Jonathan Corbet
On Fri, 26 Apr 2019 12:06:42 +0300 Jani Nikula wrote: > It's more involved, but I think the better place to do this (as well as > the kernel-doc transformations) would be in the doctree-read event, > after the rst parsing is done. You can traverse the doctree and find the > places which weren't

Re: [PATCH v2 1/2] docs/zh_CN: redirect CoC docs to Chinese version

2019-04-19 Thread Jonathan Corbet
On Tue, 16 Apr 2019 10:28:24 +0800 Alex Shi wrote: > That gives more natural reading experience for Chinese. > > Signed-off-by: Alex Shi > Cc: Harry Wei > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > Cc: linux-kernel@vger.kernel.org I've applied both of these, thanks. jon

Re: [PATCH] docs: core-api: fix broken references for div64.c and gcd.c

2019-04-19 Thread Jonathan Corbet
On Thu, 18 Apr 2019 06:50:18 -0300 Mauro Carvalho Chehab wrote: > Those files were moved to lib/math. > > Fixes: 9635bad21596 ("lib: Move mathematic helpers to separate folder") > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/core-api/kernel-api.rst | 4 ++-- > 1 file changed, 2

Re: [PATCH v2] doc: kselftest: Fix KBUILD_OUTPUT usage instructions

2019-04-19 Thread Jonathan Corbet
On Wed, 17 Apr 2019 17:34:03 -0600 Shuah Khan wrote: > Fix KBUILD_OUTPUT usage instructions. The current documentation is > incorrect. Update and fix outdated information about summary option. > Add a reference to kselftest wiki for additional information on the > framework and tips on writing

Re: [PATCH v2 00/24] Include linux ACPI docs into Sphinx TOC tree

2019-04-09 Thread Jonathan Corbet
On Tue, 9 Apr 2019 18:42:59 +0200 "Rafael J. Wysocki" wrote: > > Hardware guide > > This is more about documenting the expectations regarding the platform > firmware, so what about firmware-guide instead? I had imagined a slightly wider focus, but this seems OK for now. We can always rename

Re: [PATCH 1/4] kernel-doc: Revert "scripts/kernel-doc: Processing -nofunc for functions only"

2019-04-08 Thread Jonathan Corbet
On Fri, 5 Apr 2019 14:44:50 -0700 Sean Christopherson wrote: > Now that Docbook has been deprecated in favor of Sphinx, the -nofunction > option in kernel-doc is defunct, e.g. Sphinx doesn't currently support > it. Furthermore, "functions only" behavior was used by Docproc to avoid >

Re: [PATCH] doc:it_IT: translation for maintainer-pgp-guide

2019-04-01 Thread Jonathan Corbet
On Sat, 30 Mar 2019 22:19:56 +0100 Federico Vaga wrote: > It translates the maintainer-pgp-guide in Italian. > > Signed-off-by: Alessia Mantegazza > Signed-off-by: Federico Vaga Applied, thanks. I do wonder, though, given this: > +:Translator: Alessia Mantegazza Should this patch have

Re: [PATCH] doc:it_IT: translations for documents in process/

2019-03-18 Thread Jonathan Corbet
On Sun, 24 Feb 2019 21:05:27 +0100 Federico Vaga wrote: > Translated documents: > - stable-kernel-rules.rst > - deprecated.rst > - kernel-enforcement-statement.rst > - license-rules.rst > > Added document to have valid links > - netdev-FAQ.rst > > Modifications to main documentation > - add

Re: [PATCH v2] hid: logitech: check the return value of create_singlethread_workqueue

2019-03-12 Thread Jonathan Corbet
On Tue, 12 Mar 2019 01:16:28 -0500 Kangjie Lu wrote: > create_singlethread_workqueue may fail and return NULL. The fix > checks if it is NULL to avoid NULL pointer dereference. > Also, the fix moves the call of create_singlethread_workqueue > earlier to avoid resource-release issues. > >

[GIT PULL] Documentation for 5.1

2019-03-07 Thread Jonathan Corbet
yle: Clarify the expectations around bool Jeremy Linton (1): Documentation: Document arm64 kpti control Joel Nider (1): docs-rst: doc-guide: Minor grammar fixes Jonathan Corbet (5): Merge branch 'thorsten' into docs-next docs: don't try to get comments from rcupdate_

Re: [PATCH 2/3] objtool: move stack-validation.txt to Documentation/

2019-03-05 Thread Jonathan Corbet
On Tue, 5 Mar 2019 14:48:15 +0900 Masahiro Yamada wrote: > Move the document to the standard Documentation/ directory instead of > creating the same directory structure under objtool/. This seems like a good idea to me, but can I make a couple of requests? - Convert it to RST while you're at

[PATCH 2/2] docs: Add struct file refcounting and SCM_RIGHTS mess info

2019-03-04 Thread Jonathan Corbet
Work up some text posted by Al and add it to the filesystem manual. Co-developed-by: Al Viro Signed-off-by: Jonathan Corbet --- Documentation/filesystems/index.rst | 1 + Documentation/filesystems/lifecycles.rst | 357 +++ 2 files changed, 358 insertions(+) create

[PATCH 1/2] docs: Bring some order to filesystem documentation

2019-03-04 Thread Jonathan Corbet
just moving stuff around. Signed-off-by: Jonathan Corbet --- Documentation/filesystems/api-summary.rst | 150 Documentation/filesystems/index.rst | 394 ++ Documentation/filesystems/journalling.rst | 184 ++ Documentation/filesystems/path-lookup.rst

[RESEND PATCH 0/2] docs: Add some struct file refcounting information

2019-03-04 Thread Jonathan Corbet
air amount of language tweaking and later corrections applied. Hopefully this is just the beginning. Jonathan Corbet (2): docs: Bring some order to filesystem documentation docs: Add struct file refcounting and SCM_RIGHTS mess info Documentation/filesystems/api-summary.rst | 150 Doc

Re: [PATCH v2] Documentation/locking/lockdep: Drop last two chars of sample states

2019-03-04 Thread Jonathan Corbet
On Fri, 1 Mar 2019 10:40:52 +0100 Geert Uytterhoeven wrote: > Since the removal of FS_RECLAIM annotations, lockdep states contain four > characters, not six. > > Fixes: e5684bbfc3f03480 ("Documentation/locking/lockdep: Update info about > states") > Fixes: d92a8cfcb37ecd13 ("locking/lockdep:

Re: [PATCH] doc: rcu: Suspicious RCU usage is a warning

2019-03-04 Thread Jonathan Corbet
On Thu, 28 Feb 2019 11:59:32 +0100 Geert Uytterhoeven wrote: > Suspicious RCU usage messages are reported as warnings. > > Fixes: a5dd63efda3d07b5 ("lockdep: Use "WARNING" tag on lockdep splats") > Signed-off-by: Geert Uytterhoeven > --- > And before that, they were printed as errors, which

Re: [PATCH] docs: driver-api: iio: fix errors in documentation

2019-03-04 Thread Jonathan Corbet
On Sun, 3 Mar 2019 13:11:12 + Jonathan Cameron wrote: > On Mon, 25 Feb 2019 21:23:26 +0100 > Tomasz Duszynski wrote: > > > Improve IIO documentation by fixing a few mistakes. > > > > Signed-off-by: Tomasz Duszynski > Acked-by: Jonathan Cameron Applied, thanks. jon

Re: [PATCH v3] Documentation/process/howto: Update for 4.x -> 5.x versioning

2019-03-04 Thread Jonathan Corbet
On Wed, 27 Feb 2019 02:22:22 +0800 Zenghui Yu wrote: > As linux-5.0 is coming up soon, the howto.rst document can be > updated for the new kernel version. Instead of changing all 4.x > references to 5.x, this time we git rid of all explicit version > numbers and rework some kernel trees' name to

Re: [PATCH v2 02/10] iio: document bindings for mounting matrices

2019-02-25 Thread Jonathan Corbet
On Mon, 25 Feb 2019 19:24:36 +0100 Linus Walleij wrote: > > > .../devicetree/bindings/iio/mount-matrix.txt | 204 ++ > > So this is a device tree binding. Ah, duh, I blame caffeine deficiency. Ignore me, sorry for the noise. jon

Re: [PATCH v2] Documentation/process/howto: Update for 4.x -> 5.x versioning

2019-02-25 Thread Jonathan Corbet
On Sun, 24 Feb 2019 23:45:23 +0800 Zenghui Yu wrote: > As linux-5.0 is coming up soon, the howto.rst document can be > updated for the new kernel version. Change all 4.x references > to 5.x now. > > Signed-off-by: Zenghui Yu Overall: I think there's value in having the docs reflect current

Re: [PATCH v2 02/10] iio: document bindings for mounting matrices

2019-02-25 Thread Jonathan Corbet
On Thu, 21 Feb 2019 18:02:47 +0100 "H. Nikolaus Schaller" wrote: > From: Linus Walleij > > The mounting matrix for sensors was introduced in > commit dfc57732ad38 ("iio:core: mounting matrix support") > > However the device tree bindings are very terse and since this is > a widely applicable

Re: [PATCH] docs: Explicitly state that the 'Fixes:' tag shouldn't split lines

2019-02-22 Thread Jonathan Corbet
On Tue, 19 Feb 2019 07:27:15 -0800 Sean Christopherson wrote: > ...and use a commit with an obnoxiously long summary in the example to > make it abundantly clear that keeping the tag on a single line takes > priority over wrapping at 75 columns. Without the explicit exemption, > one might

Re: [PATCH] doc: security: Add kern-doc for lsm_hooks.h

2019-02-22 Thread Jonathan Corbet
On Sun, 17 Feb 2019 14:19:01 -0800 Kees Cook wrote: > There is a lot of kern-doc for the LSM internals, but it wasn't visible > in the HTML output. This exposes some formatting flaws in lsm_hooks.h > that will be fixed in a later series of patches. > > Signed-off-by: Kees Cook Applied,

Re: [PATCH] doc: sctp: Merge and clean up rst files

2019-02-22 Thread Jonathan Corbet
On Sun, 17 Feb 2019 19:59:20 -0800 Kees Cook wrote: > > Are you planning this to go via the doc tree, or would you like me to > > grab it for the SELinux tree? Either way is fine with me. > > > > Acked-by: Paul Moore > > Thanks! I figured it'd go via the docs tree since it's mainly moving >

Re: [PATCH] Docs: Correct /proc/stat path

2019-02-22 Thread Jonathan Corbet
On Wed, 20 Feb 2019 03:22:45 +0200 George Sofianos wrote: > The documentation for dynamic ticks in high resolution timers uses an > old path for the stat process. > > Signed-off-by: George Sofianos Applied, though I tweaked the changelog (there is no "stat process" involved here). Thanks,

Re: [PATCH] scripts/spdxcheck.py: fix C++ comment style detection

2019-02-22 Thread Jonathan Corbet
On Wed, 20 Feb 2019 22:18:34 +0100 Aurélien Cedeyn wrote: > With the last commit to support the SuperH boot code files, we have the > following regression: > > $ ./scripts/checkpatch.pl -f <(echo '/* SPDX-License-Identifier: MIT */') > WARNING: 'SPDX-License-Identifier: MIT */' is not supported

Re: [PATCH] doc: fix typos in license-rules.rst

2019-02-22 Thread Jonathan Corbet
On Wed, 20 Feb 2019 23:46:09 +0100 Federico Vaga wrote: > The patches fixes some typos in process/license-rules.rst > > Signed-off-by: Federico Vaga Applied, thanks. jon

<    2   3   4   5   6   7   8   9   10   11   >