Re: [PATCH v2] docs: driver-model: Update the documentation for device class

2021-04-20 Thread Jonathan Corbet
Manivannan Sadhasivam writes: > The current documentation about the device class is out of date such > that it refers to non-existent APIs and structures. This commit updates > them to the current device class APIs and structures, removes wordings > that no longer valid while trying to keep the

Re: [PATCH v2 01/12] docs: path-lookup: update follow_managed() part

2021-04-19 Thread Jonathan Corbet
Fox Chen writes: > On Mon, Apr 19, 2021 at 11:25 AM Matthew Wilcox wrote: >> >> On Mon, Apr 19, 2021 at 10:33:00AM +0800, Fox Chen wrote: >> > On Mon, Apr 19, 2021 at 10:17 AM Matthew Wilcox >> > wrote: >> > > You can drop ``..`` from around function named which are followed with >> > > ().

Re: [RFC] scripts: kernel-doc: improve parsing for kernel-doc comments syntax

2021-04-15 Thread Jonathan Corbet
e > content inside does not adheres to the expected format. > > Improve parsing by adding support for these probable attempts to write > kernel-doc comment. > > Suggested-by: Jonathan Corbet > Link: https://lore.kernel.org/lkml/87mtujktl2@meer.lwn.net > Signed-off-by: Adi

Re: [RFC 0/2] Add a new translation tool scripts/trslt.py

2021-04-15 Thread Jonathan Corbet
Wu XiangCheng writes: > Hi all, > > This set of patches aim to add a new translation tool - trslt.py, which > can control the transltions version corresponding to source files. > > For a long time, kernel documentation translations lacks a way to control the > version corresponding to the source

Re: [PATCH v3] Documentation: dev-tools: Add Testing Overview

2021-04-15 Thread Jonathan Corbet
David Gow writes: > The kernel now has a number of testing and debugging tools, and we've > seen a bit of confusion about what the differences between them are. > > Add a basic documentation outlining the testing tools, when to use each, > and how they interact. > > This is a pretty quick

Re: [PATCH v6] docs/zh_CN: add translations in zh_CN/dev-tools/gcov

2021-04-15 Thread Jonathan Corbet
Wu XiangCheng writes: > From: Bernard Zhao > > Add new zh translations > * zh_CN/dev-tools/gcov.rst > * zh_CN/dev-tools/index.rst > and link them to zh_CN/index.rst > > Signed-off-by: Bernard Zhao > Reviewed-by: Wu XiangCheng > Reviewed-by: Alex Shi > Reviewed-by: Fangrui Song >

Re: [PATCH] doc/virt/kvm: move KVM_X86_SET_MSR_FILTER in section 8

2021-04-13 Thread Jonathan Corbet
Emanuele Giuseppe Esposito writes: > KVM_X86_SET_MSR_FILTER is a capability, not an ioctl. > Therefore move it from section 4.97 to the new 8.31 (other capabilities). > > To fill the gap, move KVM_X86_SET_MSR_FILTER (was 4.126) to > 4.97, and shifted Xen-related ioctl (were 4.127 - 4.130) by >

Re: [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs

2021-04-13 Thread Jonathan Corbet
Fox Chen writes: > The Path lookup is a very complex subject in VFS. The path-lookup > document provides a very detailed guidance to help people understand > how path lookup works in the kernel. This document was originally > written based on three lwn articles five years ago. As times goes by,

Re: [PATCH v2 0/2] Mention regression mailing list in reporting-bugs and MAINTAINERS

2021-04-13 Thread Jonathan Corbet
Thorsten Leemhuis writes: > Hi! A mailing list for regressions was finally created as > regressi...@lists.linux.dev (we dropped the linux- prefix as the term is > already > in the domain name). Hence, add it to MAINTAINERS, as that where people will > look it up. I was a bit unsure how to

Re: [PATCH] doc:it_IT: align Italian documentation

2021-04-13 Thread Jonathan Corbet
Federico Vaga writes: > Translation for the following patches > > commit 7dfbea4c468c ("scripts: remove namespace.pl") > commit 1a63f9cce7b7 ("docs: Remove make headers_check from checklist") > commit 1e013ff7cb54 ("docs: Document cross-referencing using relative path") > commit 0be1511f516e

Re: [PATCH] Documentation/submitting-patches: Document RESEND tag on patches

2021-04-13 Thread Jonathan Corbet
Borislav Petkov writes: > Hi Jon, > > here's the next piece of documentation which should be generic enough. > > Thx. > > --- > From: Borislav Petkov > Date: Tue, 13 Apr 2021 13:26:29 +0200 > > Explain when a submitter should tag a patch or a patch series with the > "RESEND" tag. > > This has

Re: [PATCH] Documentation: dev-tools: Add Testing Overview

2021-04-11 Thread Jonathan Corbet
A nit but > +The bulk of kernel tests are written using either the :doc:`kselftest > +` or :doc:`KUnit ` frameworks. These both provide > +infrastructure to help make running tests and groups of tests easier, as well > +as providing helpers to aid in writing new tests. If you just mention the

Re: [PATCH] doc/zh_CN: Clean zh_CN translation maintainer

2021-04-08 Thread Jonathan Corbet
Wu XiangCheng writes: > Remove Harry Wei and from > MAINTAINERS Chinese Translation. > > According to git logs, Harry Wei (aka WeiWei Jia) > * last submitted at 2012-05-07 > commit a9e73211fb0f ("Fix a mistake sentence in the file > 'Documentation/zh_CN/magic-number.txt'") > * last Reviewed-by

Re: [PATCH] tools: Fix a typo in kernel-chktaint

2021-04-08 Thread Jonathan Corbet
Masanari Iida writes: > This patch fixes a spelling typo in kernel-chktaint > > Signed-off-by: Masanari Iida > --- > tools/debugging/kernel-chktaint | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/tools/debugging/kernel-chktaint b/tools/debugging/kernel-chktaint >

Re: [RFC PATCH v1 2/2] docs: reporting-issues: make everyone CC the regressions list

2021-04-08 Thread Jonathan Corbet
Thorsten Leemhuis writes: > +In case you performed a successful bisection, use the title of the change > that > +introduced the regression as the second part of your subject. Make the report > +also mention the commit id of the culprit. For tracking purposes, add a line > +like the following

Re: [RFC PATCH 5/5] tracing: Add the osnoise tracer

2021-04-08 Thread Jonathan Corbet
Daniel Bristot de Oliveira writes: A quick nit: > Documentation/trace/osnoise_tracer.rst | 149 ++ > include/linux/ftrace_irq.h | 16 + > include/trace/events/osnoise.h | 141 ++ > kernel/trace/Kconfig | 34 + > kernel/trace/Makefile

Re: [PATCH] docs: reporting-issues: Remove reference to oldnoconfig

2021-03-31 Thread Jonathan Corbet
Ismael Luceno writes: > Replace it with olddefconfig. oldnoconfig didn't do what the document > suggests (it aliased to olddefconfig), and isn't available since 4.19. > > Ref: 04c459d20448 ("kconfig: remove oldnoconfig target") > Ref: 312ee68752fa ("kconfig: announce removal of oldnoconfig if

Re: [PATCH] doc: admin-guide: remove explanation of "watchdog/%u"

2021-03-31 Thread Jonathan Corbet
Wang Qing writes: > "watchdog/%u" threads has be replaced by cpu_stop_work, > which will mislead the reader. > > Signed-off-by: Wang Qing > --- > .../admin-guide/kernel-per-CPU-kthreads.rst | 20 > > 1 file changed, 20 deletions(-) Applied, thanks. jon

Re: [PATCH 1/2] fs/namespace: corrent/improve kernel-doc notation

2021-03-31 Thread Jonathan Corbet
> ./fs/namespace.c:1950: warning: Function parameter or member 'path' not > described in 'clone_private_mount' > > Also convert path_is_mountpoint() comments to kernel-doc. > > Signed-off-by: Randy Dunlap > Cc: Al Viro > Cc: Jonathan Corbet > Cc: linux-...@vger.kern

Re: [PATCH v2 0/7] Fix some issues at get_abi.pl script

2021-03-31 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > This series replace this patch: > https://lore.kernel.org/linux-doc/20210324191722.08d35...@coco.lan/T/#t > > It turns that there were multiple bugs at the get_abi.pl code that > create cross-references. > > Patches 1 to 6 fix those issues, and should apply

Re: [PATCH 1/2] mailmap: update email address for Alex Shi

2021-03-31 Thread Jonathan Corbet
Alex Shi writes: > Add my kernel.org address for old email address. > > Signed-off-by: Alex Shi Both applied, thanks. jon

Re: [PATCH] docs: powerpc: Fix misspellings and grammar errors

2021-03-31 Thread Jonathan Corbet
He Ying writes: > Reported-by: Hulk Robot > Signed-off-by: He Ying > --- > Documentation/powerpc/booting.rst| 2 +- > Documentation/powerpc/dawr-power9.rst| 2 +- > Documentation/powerpc/eeh-pci-error-recovery.rst | 2 +- > Documentation/powerpc/elfnote.rst

Re: [PATCH] Documentation: Add leading slash to some paths

2021-03-31 Thread Jonathan Corbet
Mark O'Donovan writes: > Change multiple sys/xyz to /sys/xyz > > Signed-off-by: Mark O'Donovan > --- > Documentation/admin-guide/mm/numaperf.rst | 2 +- > Documentation/fb/fbcon.rst| 4 ++-- > Documentation/hid/intel-ish-hid.rst | 2 +- >

Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst

2021-03-31 Thread Jonathan Corbet
Greg KH writes: > On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: >> Removing Documentation/admin-guide/reporting-bugs.rst will break links >> in some of the translations. I was unsure if simply changing them to >> Documentation/admin-guide/reporting-issue.rst was wise, so I

Re: [PATCH] scripts: kernel-doc: add warning for comment not following kernel-doc syntax

2021-03-31 Thread Jonathan Corbet
Aditya Srivastava writes: > On 29/3/21 7:26 pm, Jonathan Corbet wrote: >> Aditya Srivastava writes: >> >>> Currently, kernel-doc start parsing the comment as a kernel-doc comment if >>> it starts with '/**', but does not take into account if the content in

Re: [PATCH] docs: Remove make headers_check from checklist in translations

2021-03-31 Thread Jonathan Corbet
Masahiro Yamada writes: > Hi Jon, > > > On Tue, Mar 2, 2021 at 11:19 PM Masahiro Yamada wrote: >> >> Commit 1a63f9cce7b7 ("docs: Remove make headers_check from checklist") >> fixed only the English version. >> >> Let's fix the translated variants too. >> >> Signed-off-by: Masahiro Yamada > >

Re: [1/5] reporting-issues: header and TLDR

2021-03-29 Thread Jonathan Corbet
Thorsten Leemhuis writes: > FWIW, on another channel someone mentioned the process in the TLDR is > quite complicated when it comes to regressions in stable and longterm > kernels. I looked at the text and it seemed like a valid complaint, esp. > as those regressions are something we really care

Re: kerneldoc and rust (was [PATCH] kernel-doc: better handle '::' sequences)

2021-03-29 Thread Jonathan Corbet
Matthew Wilcox writes: If we're going to talk about incorporating Rust into the doc system, we should probably include some Rust folks - thus, I'm adding Miguel. > On Thu, Mar 25, 2021 at 04:30:32PM -0600, Jonathan Corbet wrote: >> Matthew Wilcox writes: >> >> We d

Re: [PATCH] scripts: kernel-doc: add warning for comment not following kernel-doc syntax

2021-03-29 Thread Jonathan Corbet
Aditya Srivastava writes: > Currently, kernel-doc start parsing the comment as a kernel-doc comment if > it starts with '/**', but does not take into account if the content inside > the comment too, adheres with the expected format. > This results in unexpected and unclear warnings for the user.

Re: linux-next: build warnings after merge of the jc_docs tree

2021-03-26 Thread Jonathan Corbet
positives :-( > > Introduced by commit > > 8d295fbad687 ("kernel-doc: better handle '::' sequences") > > I have reverted that commit for today. Argh, that was bad, sorry, I should have caught that. Just added the following to fix it. Thanks, jon >From 212209cff89fe497b

Re: [PATCH] kernel-doc: better handle '::' sequences

2021-03-25 Thread Jonathan Corbet
Matthew Wilcox writes: > The rust code is alredy coming though ... > > rust/kernel/buffer.rs:/// A pre-allocated buffer that implements > [`core::fmt::Write`]. > > so now we have three formats. Markdown and RST are _very_ similar, but > not identical [1]. Oh, and even better we now have three

Re: [PATCH] kernel-doc: better handle '::' sequences

2021-03-25 Thread Jonathan Corbet
Matthew Wilcox writes: > On Thu, Mar 25, 2021 at 12:51:25PM -0600, Jonathan Corbet wrote: >> Mauro Carvalho Chehab writes: >> >> > Right now, if one of the following headers end with a '::', the >> > kernel-doc script will do the wrong thing: >> >

Re: [PATCH v3 0/5] docs: reporting-issues: streamline process and solve a FIXME

2021-03-25 Thread Jonathan Corbet
Thorsten Leemhuis writes: > BTW, I wondered it it would make sense to add a entry to the MAINTAINERS > file for the text so I can keep and eye on things and help with fine > tuning. Let me known if you think that idea is overblown, otherwise I'll > likely add one with the patch that I'll send

Re: [PATCH v2 0/7] Fix some issues at get_abi.pl script

2021-03-25 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > This series replace this patch: > https://lore.kernel.org/linux-doc/20210324191722.08d35...@coco.lan/T/#t > > It turns that there were multiple bugs at the get_abi.pl code that > create cross-references. > > Patches 1 to 6 fix those issues, and should apply

Re: [PATCH] kernel-doc: better handle '::' sequences

2021-03-25 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > Right now, if one of the following headers end with a '::', the > kernel-doc script will do the wrong thing: > > description|context|returns?|notes?|examples? > > The real issue is with examples, as people could try to write > something like: > >

Re: [PATCH v3 0/5] docs: reporting-issues: streamline process and solve a FIXME

2021-03-25 Thread Jonathan Corbet
Thorsten Leemhuis writes: > That's why I'd like to speed things up a little. But for that it would > be good to have something from you: a kind of "I like the direction > where this patch set is heading and I'm optimistic that we get it merged > for 5.13-rc1" message from you. With something

Re: [PATCH] docs: sphinx: Trivial fix of a typo in the file rstFlatTable.py

2021-03-25 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/buidler/builder/ > > Signed-off-by: Bhaskar Chowdhury > --- > Documentation/sphinx/rstFlatTable.py | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/sphinx/rstFlatTable.py > b/Documentation/sphinx/rstFlatTable.py > index

Re: [PATCH] docs: filesystems: Fix a mundane typo

2021-03-25 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/provisoned/provisioned/ > > Signed-off-by: Bhaskar Chowdhury > --- > Documentation/filesystems/vfat.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/filesystems/vfat.rst > b/Documentation/filesystems/vfat.rst > index

Re: [PATCH] docs: powerpc: Fix a typo

2021-03-25 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/struture/structure/ > > Signed-off-by: Bhaskar Chowdhury > --- > Documentation/powerpc/firmware-assisted-dump.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/powerpc/firmware-assisted-dump.rst >

Re: [PATCH -next v4] docs: document all error message types in checkpatch

2021-03-25 Thread Jonathan Corbet
Dwaipayan Ray writes: > All the error message types now have a verbose description. > > Also there are two new groups of message types: > > - Macros, Attributes and Symbols > - Functions and Variables > > Rearrange the message types to fit these new groups as needed. > > Reviewed-by: Lukas

Re: [PATCH] docs/kokr: make sections on bug reporting match practice

2021-03-25 Thread Jonathan Corbet
SeongJae Park writes: > From: SeongJae Park > > Translate this commit to Korean: > > cf6d6fc27936 ("docs: process/howto.rst: make sections on bug reporting > match practice") > > Signed-off-by: SeongJae Park > --- > Documentation/translations/ko_KR/howto.rst | 18 +- > 1

Re: [PATCH] Documentation: gpio: chip should be plural

2021-03-25 Thread Jonathan Corbet
Bryan Brattlof writes: > Signed-off-by: Bryan Brattlof > --- > Documentation/driver-api/gpio/intro.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/driver-api/gpio/intro.rst > b/Documentation/driver-api/gpio/intro.rst > index

Re: [PATCH] docs: rbtree.rst: Fix a typo

2021-03-25 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/maintanence/maintenance/ > > Signed-off-by: Bhaskar Chowdhury > --- > Documentation/core-api/rbtree.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Applied, thanks. jon

Re: [PATCH] docs: livepatch: Fix a typo

2021-03-25 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > On 10:05 Thu 25 Mar 2021, Miroslav Benes wrote: >>you sent the same fix a couple of weeks ago and Jon applied it. >> > Ah..difficult to rememberthanks for reminding ..it seems I need to keep > track ...which I don't do at this moment ...so the patch get

Re: [PATCH] script: get_abi.pl: escape "<" and ">" characters

2021-03-24 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > After merging the akpm-current tree, today's linux-next build (htmldocs) > produced this warning: > > Documentation/ABI/testing/sysfs-kernel-mm-cma:2: WARNING: Inline > interpreted text or phrase reference start-string without end-string. > > Introduced by

Re: [PATCH] docs: submitting-patches Fix a typo

2021-03-22 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > On 03:44 Mon 22 Mar 2021, Matthew Wilcox wrote: >>On Mon, Mar 22, 2021 at 09:00:00AM +0530, Bhaskar Chowdhury wrote: >>> >>> s/mesages/messages/ >> >>did you test the build afterwards? you forgot to do something. >> > What are you talking about??? It is going over my

Re: [PATCH v6 7/8] Documentation: Add documentation for the Brute LSM

2021-03-21 Thread Jonathan Corbet
John Wood writes: > Add some info detailing what is the Brute LSM, its motivation, weak > points of existing implementations, proposed solutions, enabling, > disabling and self-tests. > > Signed-off-by: John Wood > --- > Documentation/admin-guide/LSM/Brute.rst | 278 >

Re: [RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file

2021-03-18 Thread Jonathan Corbet
Lukas Bulwahn writes: > Yeah, and as this line-counting is really just a poor man's > heuristics, we might just be better to really turn this heuristics > into a dedicated cleanup warning script, then we can check for more > indicators, such as "does it contain the word Copyright" somewhere in >

Re: [RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file

2021-03-18 Thread Jonathan Corbet
Lukas Bulwahn writes: > I wonder if we could extend kernel-doc (not your preferred option as > it seems) for a new dedicated warning message or maintain a separate > kernel-doc sanity checking script to emit a dedicated warning based on > some heuristics that suggests when a "header comment" is

Re: linux-next: build warning after merge of the akpm-current tree

2021-03-16 Thread Jonathan Corbet
Stephen Rothwell writes: [Adding Mauro] > On Tue, 16 Mar 2021 11:18:11 -0700 Minchan Kim wrote: >> >> On Mon, Mar 15, 2021 at 04:35:22PM +1100, Stephen Rothwell wrote: >> > Hi all, >> > >> > After merging the akpm-current tree, today's linux-next build (htmldocs) >> > produced this warning:

Re: [PATCH] Documentation: sysrq: update description about sysrq crash

2021-03-15 Thread Jonathan Corbet
Gao Xiang writes: > After commit 8341f2f222d7 ("sysrq: Use panic() to force a crash"), > a crash was not generated by dereferencing a NULL pointer anymore. > > Let's update documentation as well to make it less misleading. > > Cc: Matthias Kaehlcke > Cc: Gre

Re: [PATCH v1, RFC] docs: reporting-issues.rst: tone down 'test vanilla mainline' a little

2021-03-15 Thread Jonathan Corbet
Thorsten Leemhuis writes: > Tell users that reporting bugs with vendor kernels which are only > slightly patched can be okay in some situations, but point out there's a > risk in doing so. > > Adjust some related sections to make them compatible and a bit clearer. > At the same time make them

Re: [PATCH v2 2/2] docs: reporting-issues.rst: shortcut for reporting stable regressions

2021-03-15 Thread Jonathan Corbet
Thorsten Leemhuis writes: > Provide a much shorter and easier process for users that deal with > regressions in stable and longterm kernels, as those should be reported > quickly. > > Signed-off-by: Thorsten Leemhuis > CC: Randy Dunlap Seems generally good, but I had a couple of comments...

Re: [PATCH] docs: don't include Documentation/Kconfig twice

2021-03-15 Thread Jonathan Corbet
g"'. > > Noticed as two 'make menuconfig' entries in both top level menu > and in 'Kernel hacking' menu. The patch keeps entries only in > 'Kernel hacking'. > > CC: Mauro Carvalho Chehab > CC: Jonathan Corbet > Signed-off-by: Sergei Trofimovich > --- > Kconfig

Re: [RFC PATCH] docs: Group arch-specific documentation under "CPU Architectures"

2021-03-15 Thread Jonathan Corbet
Jonathan Neuschäfer writes: > To declutter the top-level table of contents (the side bar), this > patch reduces the architecture-specfic documentation to one top-level > item, "CPU Architectures". > > Signed-off-by: Jonathan Neuschäfer > --- > > As a side effect, the TOC in index.html

Re: [PATCH v3] Expose the bus kernel docs to the build docs.

2021-03-15 Thread Jonathan Corbet
Wren Turkal writes: > Before, the bus type related APIs that were defined in the > include/linux/device/bus.h were not referenced anywhere in the docs, so > I linked it to the bus types api documentation. This should really be phrased in the imperative style as described in

Re: [PATCH] docs: dt: submitting-patches: Fix grammar in subsystem section

2021-03-15 Thread Jonathan Corbet
Geert Uytterhoeven writes: > Reword the subsystem bindings section to make sense, from a grammatical > point of view. > > Signed-off-by: Geert Uytterhoeven > --- > Documentation/devicetree/bindings/submitting-patches.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff

Re: [RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file

2021-03-15 Thread Jonathan Corbet
Aditya writes: >> The opening comment mark /** is used for kernel-doc comments [1] >> >> [1] >> https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#how-to-format-kernel-doc-comments >> > > Hi Markus! > That's true. But the content inside the comment does not follow > kernel-doc

Re: [PATCH] Documentation/features: mark BATCHED_UNMAP_TLB_FLUSH doesn't apply to ARM64

2021-03-15 Thread Jonathan Corbet
Barry Song writes: > BATCHED_UNMAP_TLB_FLUSH is used on x86 to do batched tlb shootdown by > sending one IPI to TLB flush all entries after unmapping pages rather > than sending an IPI to flush each individual entry. > On arm64, tlb shootdown is done by hardware. Flush instructions are >

Re: [PATCH] docs/zh_CN: fix original link unknown document warning

2021-03-15 Thread Jonathan Corbet
Wu XiangCheng writes: > fix original link unknown document warning in zh_CN/admin-guide/README.rst > and admin-guide/unicode.rst which introduced by commit: > > 550c8399d017 ("docs/zh_CN: Add zh_CN/admin-guide/README.rst") > > Reported-by: Stephen Rothwell > Signed-off-by: Wu XiangCheng >

Re: [PATCH] docs: admin-guide: cgroup-v1: Fix typos in the file memory.rst

2021-03-15 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/overcommited/overcommitted/ > s/Overcommiting/Overcommitting/ > > Signed-off-by: Bhaskar Chowdhury > --- > Documentation/admin-guide/cgroup-v1/memory.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git

Re: [PATCH V2] docs: livepatch: Fix a typo and remove the unnecessary gaps in a sentence

2021-03-08 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/varibles/variables/ > > ...and remove leading spaces from a sentence. > > Signed-off-by: Bhaskar Chowdhury > --- > Changes from V1: > Pter pointed out some awkward leading space in a sentence ,fixed it. > > Documentation/livepatch/shadow-vars.rst | 4 ++-- > 1

Re: [PATCH v2] docs: filesystem: Update smaps vm flag list to latest

2021-03-08 Thread Jonathan Corbet
Peter Xu writes: > We've missed a few documentation when adding new VM_* flags. Add the missing > pieces so they'll be in sync now. > > Signed-off-by: Peter Xu > --- > v2: > - rebase > --- > Documentation/filesystems/proc.rst | 4 > 1 file changed, 4 insertions(+) Applied, thanks. jon

Re: [PATCH] docs: conf.py: adjust the LaTeX document output

2021-03-08 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > Changeset f546ff0c0c07 ("Move our minimum Sphinx version to 1.7") > cleaned up some compatibility issues with previous Sphinx > versions, but it also dropped the PDF margin sets. > > Without that, the media documentation won't build fine, as > the margins are too

Re: [PATCH] Documentation/admin-guide: kernel-parameters: correct the architectures for numa_balancing

2021-03-08 Thread Jonathan Corbet
Barry Song writes: > X86 isn't the only architecture supporting NUMA_BALANCING. ARM64, PPC, > S390 and RISCV also support it: Applied, thanks. jon

Re: [PATCH] docs: kvm: Fix a typo ("althought")

2021-03-08 Thread Jonathan Corbet
Jonathan Neuschäfer writes: > Signed-off-by: Jonathan Neuschäfer > --- > Documentation/virt/kvm/api.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst > index aed52b0fc16ec..3617a64e81fe2 100644 > ---

Re: [PATCH 0/8] input: Documentation: corrections to Doc/input/ files

2021-03-08 Thread Jonathan Corbet
Randy Dunlap writes: > Update several Documentation/input/ files for wording, punctutation, > struct info, and file names. > > Cc: Dmitry Torokhov > Cc: linux-in...@vger.kernel.org > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > > [PATCH 1/8] input:

Re: [PATCH] scripts/kernel-doc: ignore identifier on anonymous enums

2021-03-08 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > When anonymous enums are used, the identifier is empty. > > While, IMO, it should be avoided the usage of such enums, > adding support for it is not hard. > > So, postpone the check for empty identifiers to happen > only at the dump phase. > > Signed-off-by: Mauro

Re: [PATCH] Documentation: dynamic-debug-howto: fix example

2021-03-08 Thread Jonathan Corbet
Martin Kepplinger writes: > dynamic debug is "expecting pairs of match-spec " so the example > for all files of which the paths include "usb" there is "file" missing. > > Signed-off-by: Martin Kepplinger > --- > Documentation/admin-guide/dynamic-debug-howto.rst | 2 +- > 1 file changed, 1

Re: [PATCH 0/2] docs: driver-model: device: Add helper macro examples

2021-03-08 Thread Jonathan Corbet
Geert Uytterhoeven writes: > Hi Jon, Greg, Rafael, > > The DEVICE_ATTR_* and ATTRIBUTE_GROUPS() helper macros have existed for > more than a decade, but are still not mentioned in the driver-model > device documentation. Hence this patch series adds them, including > examples, to the

Re: [PATCH] PATCH Documentation translations:translate sound/hd-audio/controls to chinese

2021-03-08 Thread Jonathan Corbet
hjh writes: > Signed-off-by: hjh > --- > Documentation/translations/zh_CN/index.rst| 1 + > .../zh_CN/sound/hd-audio/controls.rst | 102 ++ > .../zh_CN/sound/hd-audio/index.rst| 14 +++ > .../translations/zh_CN/sound/index.rst| 22 > 4

Re: [PATCH] media: add a subsystem profile documentation

2021-03-08 Thread Jonathan Corbet
Mauro Carvalho Chehab writes: > Document the basic policies of the media subsystem profile. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/driver-api/media/index.rst | 2 + > .../media/maintainer-entry-profile.rst| 206 ++ >

Re: [RFC v2] scripts: kernel-doc: fix attribute capture in function parsing

2021-03-08 Thread Jonathan Corbet
Aditya Srivastava writes: > Currently, kernel-doc warns for function prototype parsing on the > presence of attributes "__attribute_const__" and "__flatten" in the > definition. > > There are 166 occurrences in ~70 files in the kernel tree for > "__attribute_const__" and 5 occurrences in 4 files

Re: [PATCH 1/1] docs: arm: /chosen node parameters

2021-03-01 Thread Jonathan Corbet
Heinrich Schuchardt writes: > Add missing items to table of parameters set in the /chosen node by the EFI > stub. > > Signed-off-by: Heinrich Schuchardt > --- > Documentation/arm/uefi.rst | 7 +++ > 1 file changed, 7 insertions(+) > > diff --git a/Documentation/arm/uefi.rst

Re: [PATCH 1/2] fs: eventpoll: fix comments & kernel-doc notation

2021-03-01 Thread Jonathan Corbet
_check_proc' > ../fs/eventpoll.c:1932: warning: Function parameter or member 'ep' not > described in 'ep_loop_check' > ../fs/eventpoll.c:1932: warning: Excess function parameter 'from' description > in 'ep_loop_check' > > Signed-off-by: Randy Dunlap > Cc: Jonathan Corbet > Cc:

Re: [PATCH] Documentation: ioctl: add entry for nsfs.h

2021-03-01 Thread Jonathan Corbet
: linux-...@vger.kernel.org > Cc: Jonathan Corbet > --- > Feel free to modify the patch as needed. > > Probably don't need to backport: > # Fixes: 6786741dbf99 ("nsfs: add ioctl to get an owning user namespace for > ns file descriptor") > > Documentation/us

Re: [PATCH] Documentation: Replace more lkml.org links with lore

2021-03-01 Thread Jonathan Corbet
Kees Cook writes: > As started by commit 05a5f51ca566 ("Documentation: Replace lkml.org > links with lore"), replace a few more scattered lkml.org links with > lore to better use a single source that's more likely to stay available > long-term. > > Signed-off-by: Kees Cook > --- > CREDITS

Re: [PATCH] docs: filesystem: Update smaps vm flag list to latest

2021-03-01 Thread Jonathan Corbet
Peter Xu writes: > We've missed a few documentation when adding new VM_* flags. Add the missing > pieces so they'll be in sync now. > > Signed-off-by: Peter Xu > --- > Documentation/filesystems/proc.rst | 5 + > 1 file changed, 5 insertions(+) So this patch doesn't apply; what version of

Re: [PATCH] Documentation/submitting-patches: Extend commit message layout description

2021-03-01 Thread Jonathan Corbet
Borislav Petkov writes: > From: Borislav Petkov > Subject: [PATCH] Documentation/submitting-patches: Extend commit message > layout description > > Add more blurb about the level of detail that should be contained in a > patch's commit message. Extend and make more explicit what text should >

Re: [PATCH v3 0/3] docs: arm: Improvements to Marvell SoC documentation

2021-03-01 Thread Jonathan Corbet
Lubomir Rintel writes: > Hi, > > please consider applying the patches chained to this message. > > The objective is to deal with the a large amount of dead links to > material that often comes handy in marvel.rst; and improve some details > along the way. > > Compared to v2, the patches "[PATCH

Re: [PATCH] docs: reporting-issues.rst: explain how to decode stack traces

2021-03-01 Thread Jonathan Corbet
Thorsten Leemhuis writes: > Replace placeholder text about decoding stack traces with a section that > properly describes what a typical user should do these days. To make > it works for them, add a paragraph in an earlier section to ensure > people build their kernels with everything that's

Re: [PATCH v8 0/3] checkpatch: add verbose mode

2021-03-01 Thread Jonathan Corbet
Joe Perches writes: > On Mon, 2021-03-01 at 14:22 -0700, Jonathan Corbet wrote: >> Dwaipayan Ray writes: >> >> > Add a new verbose mode to checkpatch. The verbose test >> > descriptions are read from the new checkpatch documentation >> > file at `Docu

Re: [PATCH] docs: watchdog: fix obsolete include file reference in pcwd

2021-03-01 Thread Jonathan Corbet
Flavio Suligoi writes: > The file linux/pcwd.h is not more present in the kernel > sources. Its information is now moved into the file: > > include/uapi/linux/watchdog.h > > Signed-off-by: Flavio Suligoi > --- > Documentation/watchdog/pcwd-watchdog.rst | 2 +- > 1 file changed, 1 insertion(+),

Re: [PATCH] docs: driver-model: Remove obsolete device class documentation

2021-03-01 Thread Jonathan Corbet
Geert Uytterhoeven writes: > None of this is valid since v2.5.69. > > Signed-off-by: Geert Uytterhoeven > --- > I started updating the document, until I realized that all of the > typedefs, structures, functions, defines, and sysfs layout have been > renamed, changed, or removed. So I think

Re: [RFC v3] scripts: kernel-doc: fix typedef support for struct/union parsing

2021-03-01 Thread Jonathan Corbet
Aditya Srivastava writes: > Currently, there are ~1290 occurrences in 447 files in the kernel tree > 'typedef struct/union' syntax for defining some struct/union. However, > kernel-doc currently does not support that syntax. Of the ~1290 > occurrences, there are four occurrences in

Re: [PATCH v8 0/3] checkpatch: add verbose mode

2021-03-01 Thread Jonathan Corbet
Dwaipayan Ray writes: > Add a new verbose mode to checkpatch. The verbose test > descriptions are read from the new checkpatch documentation > file at `Documentation/dev-tools/checkpatch.rst`, which > is also added by this series. So I can certainly take the doc change, as requested. Remind

Re: [PATCH] doc: memcontrol: add description for oom_kill

2021-03-01 Thread Jonathan Corbet
Yang Shi writes: > When debugging an oom issue, I found the oom_kill counter of memcg is > confusing. At the first glance without checking document, I thought it > just counts for memcg oom, but it turns out it counts both global and > memcg oom. > > The cgroup v2 documents it, but the

Re: [PATCH] PATCH Documentation translations:translate sound/hd-audio/controls to chinese

2021-03-01 Thread Jonathan Corbet
hjh writes: > Signed-off-by: hjh > --- > Documentation/translations/zh_CN/index.rst| 1 + > .../zh_CN/sound/hd-audio/controls.rst | 102 ++ > .../zh_CN/sound/hd-audio/index.rst| 17 +++ > .../translations/zh_CN/sound/index.rst| 26 + > 4

Re: [PATCH V2] docs: sphinx: Fix couple of spellings in the file rstFlatTable.py

2021-03-01 Thread Jonathan Corbet
Bhaskar Chowdhury writes: > s/automaticly/automatically/ > s/buidler/builder/ > > ..and a sentence construction fix. > > Signed-off-by: Bhaskar Chowdhury > --- > Changes from V1: > Incorporating Randy's observations ...i.e sentence construction > > Documentation/sphinx/rstFlatTable.py | 4

[GIT PULL] Documentation fixes for 5.12

2021-02-26 Thread Jonathan Corbet
The following changes since commit 3c2e0a489da6a7c48ad67a246c7a287fcb4a4607: docs: kernel-hacking: be more civil (2021-02-11 10:00:40 -0700) are available in the Git repository at: git://git.lwn.net/linux.git tags/docs-5.12-2 for you to fetch changes up to

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

2021-02-25 Thread Jonathan Corbet
Stephen Rothwell writes: > Hi all, > > In commit > > 36eaf08fc283 ("docs: powerpc: Fix tables in syscall64-abi.rst") > > Fixes tag > > Fixes: 209b44c804c ("docs: powerpc: syscall64-abi.rst: fix a malformed > table") > > has these problem(s): > > - SHA1 should be at least 12 digits long >

Re: [PATCH v7 0/2] checkpatch: add verbose mode

2021-02-25 Thread Jonathan Corbet
Dwaipayan Ray writes: > On Thu, Feb 25, 2021 at 11:03 PM Joe Perches wrote: >> I don't have any real objection to this patch set, but as this >> might be added to the Documentation tree and in .rst format, >> perhaps Jonathan Corbet and/or Mauro Carvalho Chehab might

Re: [PATCH -next] docs: proc.rst: fix indentation warning

2021-02-25 Thread Jonathan Corbet
g") > Reported-by: Stephen Rothwell > Signed-off-by: Randy Dunlap > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > --- > shame on me. > > Documentation/filesystems/proc.rst |2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Applied, thanks. jon

Re: [PATCH] Documentation: cgroup-v2: fix path to example BPF program

2021-02-25 Thread Jonathan Corbet
Antonio Terceiro writes: > This file has been moved into the "progs" subdirectory in > bd4aed0ee73ca873bef3cb3ec746dd796f03df28, together with all test BPF > programs. > > Signed-off-by: Antonio Terceiro > Cc: Tejun Heo > Cc: Zefan Li > Cc: Johannes Weiner

Re: [PATCH 1/2] Documentation: features: remove c6x references

2021-02-25 Thread Jonathan Corbet
Arnd Bergmann writes: > From: Arnd Bergmann > > The references to arch/c6x are obsolete now that the architecture > is gone. Remove them. > > Signed-off-by: Arnd Bergmann Both applied, thanks. jon

Re: [PATCH] docs: ABI: testing: ima_policy: Fixed missing bracket

2021-02-22 Thread Jonathan Corbet
Michael Weiß writes: > This fixes a minor typo introduced by commit 3442841d: > "docs: ABI: testing: make the files compatible with ReST output" > > Signed-off-by: Michael Weiß > --- > Documentation/ABI/testing/ima_policy | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Applied,

Re: [RFC] scripts: kernel-doc: fix typedef support for struct parsing

2021-02-22 Thread Jonathan Corbet
Aditya Srivastava writes: > There are files in kernel, which use 'typedef struct' syntax for defining > struct. For eg, include/linux/zstd.h, drivers/scsi/megaraid/mega_common.h, > etc. > However, kernel-doc still does not support it, causing a parsing error. > > For eg, running

Re: [RFC] scripts: kernel-doc: fix array element capture in pointer-to-func parsing

2021-02-22 Thread Jonathan Corbet
Aditya Srivastava writes: > Currently, kernel-doc causes an unexpected error when array element (i.e., > "type (*foo[bar])(args)") is present as pointer parameter in > pointer-to-function parsing. > > For e.g., running kernel-doc -none on kernel/gcov/gcc_4_7.c causes this > error: > "Use of

Re: [PATCH] doc: use KCFLAGS instead of EXTRA_CFLAGS to pass flags from command line

2021-02-22 Thread Jonathan Corbet
Masahiro Yamada writes: > You should use KCFLAGS to pass additional compiler flags from the > command line. Using EXTRA_CFLAGS is wrong. > > EXTRA_CFLAGS is supposed to specify flags applied only to the current > Makefile (and now deprecated in favor of ccflags-y). > > It is still used in

Re: [PATCH -next] Documentation: proc.rst: add more about the 6 fields in loadavg

2021-02-22 Thread Jonathan Corbet
Randy Dunlap writes: > Address Jon's feedback on the previous patch by adding info about > field separators in the /proc/loadavg file. > > Signed-off-by: Randy Dunlap > Cc: Jonathan Corbet > Cc: linux-...@vger.kernel.org > --- > Documentation/filesystems/proc.rst |

  1   2   3   4   5   6   7   8   9   10   >