Re: [PATCH] docs/core-api: make mm-api.rst more structured

2018-12-06 Thread Jonathan Corbet
On Wed, 28 Nov 2018 16:45:44 +0200 Mike Rapoport wrote: > The mm-api.rst covers variety of memory management APIs under "More Memory > Management Functions" section. The descriptions included there are in a > random order there are quite a few of them which makes the section too > long. > >

Re: [PATCH 1/1] scripts/kernel-doc: Fix struct and struct field attribute processing

2018-11-25 Thread Jonathan Corbet
On Thu, 22 Nov 2018 13:06:04 +0200 Sakari Ailus wrote: > The kernel-doc attempts to clear the struct and struct member attributes > from the API documentation it produces. It falls short of the job in the > following respects: > > - extra whitespaces are left where __attribute__((...)) was

Re: [PATCH v2] docs/admin-guide/mm/concepts.rst: grammar and style fixups

2018-11-20 Thread Jonathan Corbet
On Sun, 11 Nov 2018 11:24:23 +0200 Mike Rapoport wrote: > Signed-off-by: Mike Rapoport > Reviewed-by: Randy Dunlap > --- > > v2: address Matthew's feedback > > Documentation/admin-guide/mm/concepts.rst | 51 > --- > 1 file changed, 26 insertions(+), 25

Re: [PATCH] docs/mm: update kmalloc kernel-doc description

2018-11-20 Thread Jonathan Corbet
On Sun, 11 Nov 2018 18:48:44 +0200 Mike Rapoport wrote: > Add references to GFP documentation and the memory-allocation.rst and remove > GFP_USER, GFP_DMA and GFP_NOIO descriptions. > > While on it slightly change the formatting so that the list of GFP flags > will be rendered as "description"

Re: [PATCH] Link the memory allocation guide from the MM docs

2018-11-20 Thread Jonathan Corbet
On Mon, 19 Nov 2018 08:00:49 -0800 Matthew Wilcox wrote: > I just went looking for the memory allocation guide in the MM docs instead > of in the core API. For the benefit of the next person who makes that > mistake, link to it from the MM docs. > > Signed-off-by: Matthew Wilcox Applied,

Re: [PATCH v2] doc: tracing: Fix a number of typos

2018-11-07 Thread Jonathan Corbet
On Thu, 1 Nov 2018 09:57:17 -0400 Amir Livneh wrote: > Trivial fixes to spelling mistakes in ftrace.rst > > v2: tripple -> triple > > Signed-off-by: Amir Livneh Applied, thanks. jon

Re: [PATCH] doc: fix a typo in adding-syscalls.rst

2018-10-18 Thread Jonathan Corbet
On Thu, 18 Oct 2018 17:47:50 +0200 cor...@poussif.eu wrote: > There was a typo in adding-syscalls.rst that could mislead developers > to add a C filename in a makefile instead of an object filename. > This error, while not keeping developers from contributing could slow > the development process

Re: [PATCH v2 00/22] xfs-4.20: major documentation surgery

2018-10-15 Thread Jonathan Corbet
On Mon, 15 Oct 2018 02:55:49 -0700 Christoph Hellwig wrote: > > OK, I've had a long conversation with the LF lawyer, and she said clearly > > that we really should not be introducing CC-SA material into the kernel > > source tree. It's a pain; I really do like CC-SA better for > >

Re: [PATCH v2 00/22] xfs-4.20: major documentation surgery

2018-10-11 Thread Jonathan Corbet
On Sat, 6 Oct 2018 10:51:54 +1000 Dave Chinner wrote: > Can you let us know whether the CC-by-SA 4.0 license is acceptible > or not? That's really the only thing that we need clarified at this > point - if it's OK I'll to pull this into the XFS tree for the 4.20 > merge window. If not, we'll go

Re: [PATCH] docs: improve readability for people with poorer eyesight

2018-10-07 Thread Jonathan Corbet
On Thu, 4 Oct 2018 18:06:03 -0700 "Darrick J. Wong" wrote: > o my eyesight still hasn't fully recovered, so in the meantime it's > been difficult to read the online documentation. Here's some stylesheet > overrides I've been using to make it easier for me to read them: >

Re: [PATCH 2/2] docs/vm: split memory hotplug notifier description to Documentation/core-api

2018-10-07 Thread Jonathan Corbet
On Fri, 5 Oct 2018 01:11:01 +0300 Mike Rapoport wrote: > The memory hotplug notifier description is about kernel internals rather > than admin/user visible API. Place it appropriately. > > Signed-off-by: Mike Rapoport One little nit... > Documentation/admin-guide/mm/memory-hotplug.rst|

Re: [PATCH 2/2] docs: promote the ext4 data structures book to top level

2018-10-07 Thread Jonathan Corbet
It > looked fine to me, but if you want to take a look it should be on the > dev branch of the ext4.git tree. FWIW, from a quick look it seems fine to me. Acked-by: Jonathan Corbet (though I expect it's too late to add that). jon

Re: [PATCH v2 00/22] xfs-4.20: major documentation surgery

2018-10-06 Thread Jonathan Corbet
On Sat, 6 Oct 2018 06:29:51 -0700 Matthew Wilcox wrote: > I had an informal chat with Bradley Kuhn at LinuxCon Japan about using > CC-BY-SA-4.0 and he indicated that I was probably better off using the > GPL-2(+) for documentation. I've changed the XArray documentation from > CC-BY-SA-4.0 to

Re: [PATCH v2 00/22] xfs-4.20: major documentation surgery

2018-10-05 Thread Jonathan Corbet
On Sat, 6 Oct 2018 10:51:54 +1000 Dave Chinner wrote: > Can you let us know whether the CC-by-SA 4.0 license is acceptible > or not? That's really the only thing that we need clarified at this > point - if it's OK I'll to pull this into the XFS tree for the 4.20 > merge window. If not, we'll go

Re: [PATCH] doc: Fix acronym "FEKEK" in ecryptfs

2018-09-20 Thread Jonathan Corbet
On Mon, 17 Sep 2018 11:34:48 +0200 Felix Eckhofer wrote: > "FEFEK" was incorrectly used as acronym for "File Encryption Key > Encryption Key". This replaces all occurences with "FEKEK". > > Signed-off-by: Felix Eckhofer > --- > Documentation/security/keys/ecryptfs.rst | 8 > 1 file

Re: nodocs in 4.19-rcX

2018-09-11 Thread Jonathan Corbet
On Mon, 10 Sep 2018 15:51:20 -0700 Randy Dunlap wrote: > 4.19-rc contains some users of :nodocs: but that is not recognized yet, > so we get: > > lnx-419-rc3/Documentation/core-api/boot-time-mm.rst:78: ERROR: Error in > "kernel-doc" directive: > unknown option: "nodocs". > > .. kernel-doc::

Re: [PATCH 2/2] MAINTAINERS: add i2c to the excludes for Documentation

2018-09-09 Thread Jonathan Corbet
On Fri, 7 Sep 2018 12:30:22 +0200 Wolfram Sang wrote: > I'll handle these myself but thanks for providing the fallback! > > Signed-off-by: Wolfram Sang > --- > MAINTAINERS | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/MAINTAINERS b/MAINTAINERS > index 2698ee553008..39c39dd6fba6

Re: Italian translations and broken links

2018-08-24 Thread Jonathan Corbet
On Fri, 24 Aug 2018 13:51:18 +0200 Federico Vaga wrote: > Since there are many documents, this take time and perhaps we can already > push > the ones which are ready. > > My big dilemma is (which is more general): what about broken references? Do > we > keep broken links which we know they

Re: [PATCH] Remove gendered language from management style documentation

2018-08-10 Thread Jonathan Corbet
On Tue, 7 Aug 2018 19:47:51 +0100 Fox Foster wrote: > This small commit replaces gendered pronouns for neutral ones. > > Signed-off-by: Fox Foster Applied, thanks. jon

Re: [PATCH v2] scripts/kernel-doc: Escape all literal braces in regexes

2018-08-06 Thread Jonathan Corbet
On Sun, 5 Aug 2018 17:41:09 +0100 Ben Hutchings wrote: > Commit 720ac2ef479d ("PATCH scripts/kernel-doc") fixed the two > instances of literal braces that Perl 5.28 warns about, but there are > still more than it doesn't warn about. > > Escape all left braces that are treated as literal

Re: [PATCH v2] scripts/kernel-doc: Escape all literal braces in regexes

2018-08-06 Thread Jonathan Corbet
On Sun, 5 Aug 2018 17:41:09 +0100 Ben Hutchings wrote: > Commit 720ac2ef479d ("PATCH scripts/kernel-doc") fixed the two > instances of literal braces that Perl 5.28 warns about, but there are > still more than it doesn't warn about. So where can I find this commit of which you speak? I can't

Re: [PATCH v1] doc: translation for block queue into Chinese

2018-08-02 Thread Jonathan Corbet
On Fri, 27 Jul 2018 10:41:19 +0800 Norman wrote: > Translate block/queue-sysfs.txt into Chinese > > Signed-off-by: Norman Kern Unfortunately, this patch has been white-space mangled by your mailer. Please fix your mailer (Documentation/process/email-clients.rst has useful hints to that end)

Re: [PATCH] zh_CN:translation for block queue into Chinese

2018-07-23 Thread Jonathan Corbet
On Fri, 20 Jul 2018 10:27:06 +0800 Norman wrote: > Translate block/queue-sysfs.txt into Chinese > > Signed-off-by: Norman Kern > --- >  .../translations/zh_CN/block/queue-sysfs.md    | 205 > + So...are you translating this into markdown format? Please don't do that,

Re: [RFC]:Involved in Linux doc translation for Chinese

2018-07-19 Thread Jonathan Corbet
On Thu, 19 Jul 2018 18:20:52 +0800 Norman wrote: > 'Documentation/translations/'  has been discarded or not ? I found few > translations there :( It certainly has not been discarded. But it also cannot grow in the absence of contributions from interested developers — I certainly can't fill it

Re: [PATCH] Documentation : Update relay function types

2018-07-10 Thread Jonathan Corbet
On Sun, 8 Jul 2018 20:19:32 +0200 Yohan Pipereau wrote: > This patch updates two callback functions provided as an example in > relay API documentation : subbuf_start and create_buf_file_handler. > > These functions were using older and incorrect types causing an > "initialization from

Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters

2018-06-30 Thread Jonathan Corbet
On Sat, 30 Jun 2018 17:59:27 +0300 Mike Rapoport wrote: > > > > Is this the right syntax? Should we rather have: > > > > .. kernel-doc:: lib/idr.c > >:functions: * > > IMHO :functions: with no parameters is simpler. What I would really like to have there, actually, is a regex

Re: [PATCH v3 0/2] Documentation/sphinx: add kind of "nodocs" directive

2018-06-30 Thread Jonathan Corbet
On Fri, 29 Jun 2018 15:07:34 -0600 Jonathan Corbet wrote: > > These patches allow passing "-no-doc-sections" option to scripts/kernel-doc > > from the sphinx generator. > > > > This allows to avoid duplicated DOC: sections when "kernel-doc:" dire

Re: [PATCH v3 0/2] Documentation/sphinx: add kind of "nodocs" directive

2018-06-29 Thread Jonathan Corbet
On Sat, 30 Jun 2018 00:05:09 +0300 Mike Rapoport wrote: > These patches allow passing "-no-doc-sections" option to scripts/kernel-doc > from the sphinx generator. > > This allows to avoid duplicated DOC: sections when "kernel-doc:" directive > is used without explicit selection of functions or

Re: [PATCH v2 1/2] Documentation/sphinx: allow "functions" with no parameters

2018-06-26 Thread Jonathan Corbet
On Wed, 20 Jun 2018 11:49:12 +0300 Mike Rapoport wrote: > > Looks good to me. Though I do realize now that I overlooked that this > > applies to not only functions, but also to other non-DOC documentation > > comments. I guess up to Jon to decide. > > We can name it

Re: [PATCH] docs/vm: move ksm and transhuge from "user" to "internals" section.

2018-05-29 Thread Jonathan Corbet
On Tue, 29 May 2018 13:13:38 +0300 Mike Rapoport wrote: > After the userspace interface description for KSM and THP was split to > Documentation/admin-guide/mm, the remaining parts belong to the section > describing MM internals. > > Signed-off-by: Mike Rapoport Applied, thanks. jon -- To

Re: doc: Italian translation

2018-05-28 Thread Jonathan Corbet
On Sun, 27 May 2018 16:55:55 +0200 Federico Vaga wrote: > here the doc-guide translated in Italian. This set of patches includes > some minor changes to the main one. The idea of this first set of patches > is also to adjust the structure and our expectations. I've

Re: [PATCH] docs: update kernel versions and dates in tables

2018-05-23 Thread Jonathan Corbet
On Wed, 23 May 2018 15:20:14 -0700 Tim Bird wrote: > Every once in a while, we should update the examples > to reflect more recent kernel versions. > > Update the tables describing kernel releases, the merge window, > and current longterm maintained kernel, from 2.6-era

Re: Documentation/translations: Italian

2018-05-21 Thread Jonathan Corbet
On Mon, 21 May 2018 22:54:18 +0200 Federico Vaga wrote: > I'm writing you because I would like to start an effort to translate the > Documentation in Italian. I would like also to express the idea of providing > guide lines for translations. Mi sembra un'ottima idea!

Re: [PATCH 0/3] docs/vm: transhuge: split userspace bits to admin-guide/mm

2018-05-21 Thread Jonathan Corbet
On Mon, 14 May 2018 11:13:37 +0300 Mike Rapoport wrote: > Here are minor updates to transparent hugepage docs. Except from minor > formatting and spelling updates, these patches re-arrange the transhuge.rst > so that userspace interface description will not be

Re: [PATCH v2] coresight: documentation: update sysfs section

2018-05-16 Thread Jonathan Corbet
On Mon, 14 May 2018 12:19:59 -0500 Kim Phillips wrote: > - Align and show updated ls devices output from the TC2, based on > current driver > > - Provide an example from an ETMv4 based system (Juno) > > - Reflect changes to the way the RAM write pointer is accessed

Re: [PATCH] Documentation: gpio: driver: Fix a typo and some odd grammar

2018-05-16 Thread Jonathan Corbet
On Wed, 16 May 2018 14:08:00 +0200 Jonathan Neuschäfer wrote: > Signed-off-by: Jonathan Neuschäfer Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org

Re: [PATCH v2 00/11] Fix some doc build warnings/errors and broken links

2018-05-10 Thread Jonathan Corbet
On Wed, 9 May 2018 10:18:43 -0300 Mauro Carvalho Chehab wrote: > Patches 1 to 5 on this series contain the patches that weren't yet > applied from the past patch series and touch only at Documentation. > There are two changes there: > patch 2: fixed the description

Re: [PATCH -mm] mm, THP, doc: Add document for thp_swpout/thp_swpout_fallback

2018-05-10 Thread Jonathan Corbet
On Wed, 9 May 2018 16:23:41 +0800 "Huang, Ying" wrote: > From: Huang Ying > > Add document for newly added thp_swpout, thp_swpout_fallback fields in > /proc/vmstat. > > Signed-off-by: "Huang, Ying" > Cc: "Kirill A. Shutemov"

Re: [PATCH] Documentation/process/posting: wrap text at 80 cols

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 20:37:37 +0100 Justin Skists wrote: > Trivial patch to adjust the text formatting to wrap at 80 columns. No > actual content has changed. > > Signed-off-by: Justin Skists Applied, thanks. jon -- To unsubscribe from

Re: [PATCH v2 02/11] docs: admin-guide: add cgroup-v2 documentation

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 11:40:18 -0700 Tejun Heo wrote: > On Wed, May 09, 2018 at 10:18:45AM -0300, Mauro Carvalho Chehab wrote: > > The cgroup-v2.txt is already in ReST format. So, move it to the > > admin-guide, where it belongs. > > > > Cc: Tejun Heo > > Cc: Li

Re: [RFC PATCH 1/2] scripts/kernel-doc: Auto-detect common code-blocks

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 09:34:56 -0700 Matthew Wilcox wrote: > I think this is a bit fragile. Why not just search for ':\n'? Is > there ever a case where we want to write: > > /** > * foo is a bar: > * wibble > */ > and have wibble not be a code-block? Yeah, we might want

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 11:21:13 -0300 Mauro Carvalho Chehab wrote: > The problem with a hint-based mechanism is that it will generate > false hints. If added, we may end by needing to add extra tags to > disable the hints mechanism where it gets wrong, or to periodically

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 07:30:12 -0600 Jonathan Corbet <cor...@lwn.net> wrote: > > (Peter said): > > > Independent of any philosophical discussion not allowing a setence to > > > end with a single ':' is completely idiotic. Please fix the tooling > > > inste

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 06:38:05 -0300 Mauro Carvalho Chehab wrote: > (Peter said): > > Independent of any philosophical discussion not allowing a setence to > > end with a single ':' is completely idiotic. Please fix the tooling > > instead to allow it, as it is very

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

2018-05-10 Thread Jonathan Corbet
On Thu, 10 May 2018 14:23:35 +0200 Andrea Parri wrote: > only > remember that other people (including some developers running into the > "disadventure" of opening an RST doc. from their preferred text editor > and being brought to conclude: "WTH! I need to

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

2018-05-09 Thread Jonathan Corbet
On Wed, 9 May 2018 17:20:26 +0200 Peter Zijlstra wrote: > The whole rst wankery is detrimental to that interface in order to > pander to something else.. I don't see the value. I've objected before, > and I suppose I'll object again. One person's wankery is another's

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

2018-05-09 Thread Jonathan Corbet
On Wed, 9 May 2018 10:41:20 +0200 Peter Zijlstra wrote: > > This is easily done by using "::" instead of just ":". > > And I'll voice my objection once again. This makes a regular comment > worse. This rst stuff is utter shit for making normal text files less > readable

Re: [PATCH 18/18] w1: w1_io.c: fix a kernel-doc warning

2018-05-09 Thread Jonathan Corbet
On Wed, 9 May 2018 09:32:18 -0300 Mauro Carvalho Chehab wrote: > > Looks good to me, thank you! > > What tree should this be forwarded to, or folks from linux doc will pick it > > up? > > > > Acked-by: Evgeniy Polyakov > > Jon prefers if this

Re: [PATCH] Documentation: refcount-vs-atomic: Update reference to LKMM doc.

2018-05-08 Thread Jonathan Corbet
On Fri, 4 May 2018 23:11:49 +0200 Andrea Parri wrote: > The LKMM project has moved to 'tools/memory-model/'. > > Signed-off-by: Andrea Parri Applied, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH 00/18] Fix some build warnings/errors with Sphinx

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:36 -0300 Mauro Carvalho Chehab wrote: > I decided to give a try with Sphinx last stable version > (1.17.4), and noticed several issues. The worse one was > with the networking book: a non-standard footnote there > with [*] instead of a number

Re: [PATCH 08/18] docs: driver-api: add clk documentation

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:44 -0300 Mauro Carvalho Chehab wrote: > The clk.rst is already in ReST format. So, move it to the > driver-api guide, where it belongs. > > Signed-off-by: Mauro Carvalho Chehab Applied, thanks. jon -- To

Re: [PATCH 07/18] docs: core-api: add circular-buffers documentation

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:43 -0300 Mauro Carvalho Chehab wrote: > The circular-buffers.txt is already in ReST format. So, move it to the > core-api guide, where it belongs. > > Signed-off-by: Mauro Carvalho Chehab Applied, thanks. jon

Re: [PATCH 05/18] docs: core-api: add cachetlb documentation

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:41 -0300 Mauro Carvalho Chehab wrote: > The cachetlb.txt is already in ReST format. So, move it to the > core-api guide, where it belongs. > > Signed-off-by: Mauro Carvalho Chehab I think we could do a better

Re: [PATCH 04/18] docs: admin-guide: add bcache documentation

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:40 -0300 Mauro Carvalho Chehab wrote: > The bcache.txt is already in ReST format. So, move it to the > admin guide, where it belongs. > > Signed-off-by: Mauro Carvalho Chehab Applied, thanks. jon -- To

Re: [PATCH 03/18] docs: */index.rst: Add newer documents to their respective index.rst

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:39 -0300 Mauro Carvalho Chehab wrote: > A number of new docs were added, but they're currently not on > the index.rst from the session they're supposed to be, causing > Sphinx warnings. > > Add them. > > Signed-off-by: Mauro Carvalho Chehab

Re: [PATCH 06/18] docs: core-api: add cgroup-v2 documentation

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:42 -0300 Mauro Carvalho Chehab wrote: > The cgroup-v2.txt is already in ReST format. So, move it to the > core-api guide, where it belongs. > > Signed-off-by: Mauro Carvalho Chehab Honestly, this seems to me

Re: [PATCH 0/3] docs/vm: move numa_memory_policy.rst to admin-guide/mm

2018-05-08 Thread Jonathan Corbet
On Tue, 8 May 2018 10:02:07 +0300 Mike Rapoport wrote: > These patches include minor formatting and spelling updates to > Documentation/vm/numa_memory_policy.rst and move this file to > Documentation/admin-guide/mm. Set applied - thanks! jon -- To unsubscribe from

Re: [RFC PATCH v3 0/6] Documentation/features: Provide and apply 'features-refresh.sh'

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 12:43:37 +0200 Andrea Parri wrote: > This series provides the script 'features-refresh.sh', which operates on > the arch support status files, and it applies this script to refresh the > status files in place; previous discussions about this

Re: [PATCH] Documentation: block: cmdline-partition.txt fixes and additions

2018-05-08 Thread Jonathan Corbet
On Sun, 6 May 2018 11:50:29 -0700 Randy Dunlap wrote: > Make the description of the kernel command line option "blkdevparts" > a bit more flowing and readable. > > Fix a few typos. > Add the optional and suffixes. > Note that size can be "-" to indicate all of the

Re: [PATCH] vfio: fix documentation

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 11:02:10 +0800 "dongbo (E)" wrote: > Update vfio_add_group_dev description to match the current API. > > Signed-off-by: Dong Bo Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body

Re: [PATCH] doc: botching-up-ioctls: Make it clearer why structs must be padded

2018-05-08 Thread Jonathan Corbet
On Wed, 2 May 2018 09:51:06 +0200 Daniel Vetter wrote: > This came up in discussions when reviewing drm patches. Applied, thanks. > Aside: I wonder whether we shouldn't move this to some other place and > rst-ify it? Any good suggestions? For the moment, probably in

Re: [PATCH resend] VFS: simplify seq_file iteration code and interface

2018-04-30 Thread Jonathan Corbet
s in a hash table, e.g. using rhashtable_walk*. See > fs/gfs2/glock.c and drivers/staging/lustre/lustre/llite/vvp_dev.c For the docs part: Acked-by: Jonathan Corbet <cor...@lwn.net> jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body

Re: [PATCH 0/7] docs/vm: update KSM documentation

2018-04-27 Thread Jonathan Corbet
On Tue, 24 Apr 2018 09:40:21 +0300 Mike Rapoport wrote: > These patches extend KSM documentation with high level design overview and > some details about reverse mappings and split the userspace interface > description to Documentation/admin-guide/mm. > > The

Re: [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error

2018-04-27 Thread Jonathan Corbet
On Thu, 26 Apr 2018 18:29:41 -0700 Randy Dunlap wrote: > Using incorrect :functions: syntax (extra space) causes an odd kernel-doc > warning, so fix that. > > Documentation/driver-api/device_connection.rst:42: ERROR: Error in > "kernel-doc" directive: Applied, thanks.

Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections

2018-04-27 Thread Jonathan Corbet
On Thu, 26 Apr 2018 18:11:02 -0700 Randy Dunlap wrote: > Rearrange some kernel-api chapters and sections to group them > together better. > > - move Bit Operations from Basic C Library Functions to Basic > Kernel Library Functions (now adjacent to Bitmap Operations

Re: [PATCH 0/7] docs/vm: start moving files do Documentation/admin-guide`

2018-04-27 Thread Jonathan Corbet
On Wed, 18 Apr 2018 11:07:43 +0300 Mike Rapoport wrote: > These pacthes begin categorizing memory management documentation. The > documents that describe userspace APIs and do not overload the reader with > implementation details can be moved to

Re: [PATCH v2 0/3] coresight: Refresh documenation

2018-04-27 Thread Jonathan Corbet
On Tue, 17 Apr 2018 10:08:04 -0600 Mathieu Poirier wrote: > Now that the perf tools CoreSight support is upstream this set adds > documentation to go with it and move things around so that topics > are located together. I've applied the set, thanks. jon -- To

Re: [PATCH v2] doc: dev-tools: kselftest.rst: update contributing new tests

2018-04-27 Thread Jonathan Corbet
On Thu, 19 Apr 2018 12:28:25 +0200 Anders Roxell wrote: > Add a description that the kernel headers should be used as far as it is > possible and then the system headers. > > Signed-off-by: Anders Roxell Applied, thanks. jon -- To

Re: [PATCH v3] docs: kernel-parameters.txt: Fix whitespace

2018-04-27 Thread Jonathan Corbet
On Wed, 18 Apr 2018 20:51:39 +0200 Thymo van Beers wrote: > Some lines used spaces instead of tabs at line start. > This can cause mangled lines in editors due to inconsistency. > > Replace spaces for tabs where appropriate. Applied, thanks. jon -- To unsubscribe from

Re: [PATCH] linux-next: ftrace/docs: Fix spelling typos in ftrace-users.rst

2018-04-27 Thread Jonathan Corbet
On Fri, 27 Apr 2018 18:17:09 -0400 Steven Rostedt wrote: > I just noticed that this was never applied. > > Jon, can you take this? Wow...from November. Not sure what happened...applied now, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe

Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art

2018-04-25 Thread Jonathan Corbet
On Wed, 25 Apr 2018 16:47:01 +0300 Jani Nikula wrote: > On Fri, 06 Apr 2018, Heikki Krogerus wrote: > > Using reStructuredText literal-block element with ascii-art. > > That prevents the ascii art from being processed as > >

Re: [PATCH] docs: ip-sysctl.txt: fix name of some ipv6 variables

2018-04-18 Thread Jonathan Corbet
On Wed, 18 Apr 2018 12:31:34 +0200 Olivier Gayot wrote: > The name of the following proc/sysctl entries were incorrectly > documented: > > /proc/sys/net/ipv6/conf//max_dst_opts_number > /proc/sys/net/ipv6/conf//max_hbt_opts_number >

Re: [PATCH 00/32] docs/vm: convert to ReST format

2018-04-16 Thread Jonathan Corbet
On Sun, 15 Apr 2018 20:36:56 +0300 Mike Rapoport wrote: > I didn't mean we should keep it as unorganized jumble of stuff and I agree > that splitting the documentation by audience is better because developers > are already know how to find it :) > > I just thought that

Re: [PATCH] docs: kernel-parameters.txt: Fix whitespace

2018-04-16 Thread Jonathan Corbet
On Mon, 16 Apr 2018 17:45:01 +0200 Thymo van Beers wrote: > Some lines used spaces instead of tabs at line start. > This can cause mangled lines in editors due to inconsistency. > > Replace spaces for tabs where appropriate. Seems like a fine idea. The patch doesn't

Re: [PATCH] Changed .txt to .rst in Documentation/sound/*.rst

2018-04-16 Thread Jonathan Corbet
On Wed, 11 Apr 2018 18:33:26 +0200 Christina Quast wrote: > Here is a small fixup for the documentation. Unless it's too trivial to > change it. Applied, thanks. In the future, though, please send patches inline rather than as attachments; that way I don't have to clean

Re: [PATCH 00/32] docs/vm: convert to ReST format

2018-04-13 Thread Jonathan Corbet
Sorry for the silence, I'm pedaling as fast as I can, honest... On Sun, 1 Apr 2018 09:38:58 +0300 Mike Rapoport wrote: > My thinking was to start with mechanical RST conversion and then to start > working on the contents and ordering of the documentation. Some of the >

Re: [PATCH v2] Documentation: ftrace: clarify filters with dynamic ftrace and graph

2018-04-13 Thread Jonathan Corbet
On Fri, 13 Apr 2018 11:54:03 -0400 Steven Rostedt wrote: > Jon, you want to take it in your tree? Sure, I'll grab it. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at

Re: [PATCH] Fixed typo in onewire generic doc

2018-04-09 Thread Jonathan Corbet
On Mon, 09 Apr 2018 02:56:49 +0300 Evgeniy Polyakov wrote: > Hi everyone > > I'm really sorry for that long delay. > > Was this patch accepted or should I push it upstream? > > 20.12.2017, 22:09, "Gergo Huszty" : > > Onewire devices has 6 byte

[PULL] Documentation for 4.17

2018-04-02 Thread Jonathan Corbet
(1): Documentation/process: Co-developed-by instead of Co-Developed-by Eric Engestrom (1): Documentation/sparse: fix typo Gary R Hook (1): Documentation/CodingStyle: Add an example for braces Joel Stanley (1): Documentation: Mention why %p prints ptrval Jonathan Corbet

Re: [PATCH] syscalls: define and explain goal to not call syscalls in the kernel

2018-03-30 Thread Jonathan Corbet
On Sun, 25 Mar 2018 18:25:27 +0200 Dominik Brodowski wrote: > As there have been multiple inquiries on the rationale of my patchsets > removing in-kernel calls to sys_xyzzy(), here is an updated patch 01/NN > which I will push upstream for v4.17-rc1. I will also

Re: [PATCH] Documentation/wimax: Point dead link to working copy

2018-03-29 Thread Jonathan Corbet
On Wed, 28 Mar 2018 22:47:07 +0800 Sanjeev Gupta wrote: > The linuxwimax.org domain, registered by the Linux Foundation, > no longer has any DNS entries. Locate a copy on archive.org and > update the documentation. Hmm...I worry a bit about pointing into archive.org; it's not

Re: [PATCH] Documentation/process: update FUSE project website

2018-03-29 Thread Jonathan Corbet
On Tue, 27 Mar 2018 14:59:50 +0200 Martin Kepplinger wrote: > According to the old project site, https://sourceforge.net/projects/fuse/ > the project has moved to https://github.com/libfuse/ so we update the > link to point to the latest libfuse release. Applied, thanks. jon

Re: [PATCH] docs: kernel-doc: fix parsing of arrays

2018-03-29 Thread Jonathan Corbet
On Thu, 29 Mar 2018 10:58:59 -0400 Mauro Carvalho Chehab wrote: > The logic with parses array has a bug that prevents it to > parse arrays like: > struct { > ... > struct { > u64 msdu[IEEE80211_NUM_TIDS + 1]; >

Re: [PATCH 00/32] docs/vm: convert to ReST format

2018-03-29 Thread Jonathan Corbet
On Wed, 21 Mar 2018 21:22:16 +0200 Mike Rapoport wrote: > These patches convert files in Documentation/vm to ReST format, add an > initial index and link it to the top level documentation. > > There are no contents changes in the documentation, except few spelling >

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

2018-03-26 Thread Jonathan Corbet
On Mon, 26 Mar 2018 11:28:03 -0500 Gary R Hook wrote: > Submitting a v3 because the example could better illuminate the options > by using loop construct inside of an if, addressing Jani's point but > without opening the door to later criticism. > > I also like the verbage

Re: [PATCH] Documentation: magic-numbers: Fix typo

2018-03-26 Thread Jonathan Corbet
On Fri, 23 Mar 2018 08:32:31 +0100 Martin Kepplinger wrote: > This fixes a little then / them confusion. > > Signed-off-by: Martin Kepplinger > --- > Documentation/process/magic-number.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff

Re: [PATCH] Documentation: admin-guide: add kvmconfig, xenconfig and tinyconfig commands

2018-03-26 Thread Jonathan Corbet
On Thu, 22 Mar 2018 13:06:56 +0100 Martin Kepplinger wrote: > Add kvmconfig, xenconfig and tinyconfig to the list of alternative > configuration commands. Descriptions are directly taken from the Makefile. Applied to the docs tree, thanks. jon -- To unsubscribe from this

Re: [PATCH] Input: alps - Update documentation for trackstick v3 format

2018-03-26 Thread Jonathan Corbet
On Wed, 21 Mar 2018 21:03:36 +0100 Pali Rohár wrote: > Bits for M, R and L buttons are already processed in alps. Other newly > documented bits not yet. > > Signed-off-by: Pali Rohár > --- > This is based on information which Masaki Ota provided to

Re: [PATCH] Documentation: Mention why %p prints ptrval

2018-03-23 Thread Jonathan Corbet
On Thu, 22 Mar 2018 15:53:36 +1030 Joel Stanley wrote: > When debugging recent kernels, people will see '(ptrval)' but there > isn't much information as to what that means. Briefly describe why it's > there. Applied, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH v2 0/2] COPYING: create a new file with points to the Kernel license files

2018-03-23 Thread Jonathan Corbet
On Fri, 23 Mar 2018 06:51:04 -0300 Mauro Carvalho Chehab wrote: > The contents of COPYING file is now duplicated at two other > files under LICENSE: > LICENSES/preferred/GPL-2.0 > LICENSES/exceptions/Linux-syscall-note > > Also, a new file was added, with

Re: [PATCH] Input: trackpoint: document sysfs interface

2018-03-21 Thread Jonathan Corbet
On Fri, 2 Mar 2018 23:00:19 +0530 Aishwarya Pant wrote: > Descriptions have been collected from git commit logs, code commits and > the TrackPoint System Version 4.0 Engineering Specification. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the

Re: [PATCH] xfs: Change URL for the project in xfs.txt

2018-03-21 Thread Jonathan Corbet
On Fri, 2 Mar 2018 22:30:13 +0900 Masanari Iida wrote: > The oss.sgi.com doesn't exist any more. > Change it to current project URL, https://xfs.wiki.kernel.org/ Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe

Re: [PATCH] HID: ntrig: document sysfs interface

2018-03-21 Thread Jonathan Corbet
On Wed, 21 Mar 2018 09:28:05 -0600 Jonathan Corbet <cor...@lwn.net> wrote: > > Add sysfs documentation for N-Trig touchscreens under Documentation/ABI. > > Descriptions have been collected from code comments. > > Applied to the docs tree, thanks. Oops, I thought I'

Re: [PATCH] HID: logitech-hidpp: document sysfs interface

2018-03-21 Thread Jonathan Corbet
On Fri, 2 Mar 2018 18:46:53 +0530 Aishwarya Pant wrote: > Descriptions have been collected from git commit logs. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH] HID: ntrig: document sysfs interface

2018-03-21 Thread Jonathan Corbet
On Fri, 2 Mar 2018 11:00:17 +0530 Aishwarya Pant wrote: > Add sysfs documentation for N-Trig touchscreens under Documentation/ABI. > Descriptions have been collected from code comments. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH] char/bsr: add sysfs interface documentation

2018-03-21 Thread Jonathan Corbet
On Thu, 1 Mar 2018 23:55:59 +0530 Aishwarya Pant wrote: > Descriptions have collected from code comments and by reading through > code. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

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

2018-03-21 Thread Jonathan Corbet
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: [PATCH v2] Documentation/CodingStyle: Add an example for braces

2018-03-21 Thread Jonathan Corbet
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] docs/vm: update 00-INDEX

2018-03-21 Thread Jonathan Corbet
On Wed, 21 Mar 2018 17:05:23 +0200 Mike Rapoport wrote: > Several files were added to Documentation/vm without updates to 00-INDEX. > Fill in the missing documents Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body

Re: [PATCH] kernel-doc: Remove __sched markings

2018-03-21 Thread Jonathan Corbet
On Thu, 15 Mar 2018 05:06:23 -0700 Matthew Wilcox wrote: > I find the __sched annotations unaesthetic in the kernel-doc. Remove > them like we remove __inline, __weak, __init and so on. Makes sense, applied, thanks. jon -- To unsubscribe from this list: send the line

  1   2   3   4   5   6   7   8   >