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

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 diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core

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

On Mon, Nov 05, 2018 at 09:58:15PM +0200, Mike Rapoport wrote: > @@ -21,10 +21,10 @@ Virtual Memory Primer > The physical memory in a computer system is a limited resource and > even for systems that support memory hotplug there is a hard limit on > the amount of memory that can be installed.

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

On Sat, Oct 06, 2018 at 10:51:54AM +1000, Dave Chinner wrote: > On Wed, Oct 03, 2018 at 09:18:11PM -0700, Darrick J. Wong wrote: > > Hi all, > > > > This series converts the existing in-kernel xfs documentation to rst > > format, links it in with the rest of the kernel's rst documetation, and > >

[PATCH 2/2] fs: Add more kernel-doc to the produced documentation

People have gone to all the effort of writing kernel-doc for these functions; the least we can do is put them in the "Other functions" part of the VFS documentation. Signed-off-by: Matthew Wilcox --- Documentation/filesystems/index.rst | 33 + 1 file c

[PATCH 1/2] fs: Fix attr.c kernel-doc

A couple of minor warnings. Signed-off-by: Matthew Wilcox --- fs/attr.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/fs/attr.c b/fs/attr.c index e3d53bf12240..d22e8187477f 100644 --- a/fs/attr.c +++ b/fs/attr.c @@ -120,7 +120,6 @@ EXPORT_SYMBOL(setattr_prepare

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

On Sat, Jun 30, 2018 at 12:05:10AM +0300, Mike Rapoport wrote: > @@ -488,14 +488,19 @@ doc: *title* > .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c > :doc: High Definition Audio over HDMI and Display Port > > -functions: *function* *[...]* > +functions: *[ function ...]* >

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

On Mon, Jun 18, 2018 at 10:10:28AM -0700, Matthew Wilcox wrote: > On Mon, Jun 18, 2018 at 04:36:34PM +0300, Mike Rapoport wrote: > > Hi, > > > > These patches allow passing "-no-doc-sections" option to scripts/kernel-doc > > from the sphinx generator. > &g

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

e > is used without explicit selection of functions or function types. For > instance, [1] has "IDA description" and "idr synchronization" twice. Hah, I just found an abandoned patch for this in a disused git tree. I was wondering whether I needed to resurrect it. Ent

Re: [PATCH 1/5] PCI/AER: Define and allocate aer_stats structure for AER capable devices

On Wed, May 23, 2018 at 10:20:10AM -0400, Jes Sorensen wrote: > > +++ b/drivers/pci/pcie/aer/aerdrv_stats.c > > @@ -0,0 +1,64 @@ > > +// SPDX-License-Identifier: GPL-2.0 > > Fix the formatting please - that gross // gibberish doesn't belong there. Sorry, Jes. The Chief Penguin has Spoken, and

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

On Thu, May 10, 2018 at 10:38:16AM -0400, Mauro Carvalho Chehab wrote: > Comments that end with a comma and have certain keywords > should be presented as code-blocks 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:

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

ng and Searching close to each other) > > - combine CRC and Math functions together into the (newly named) > CRC and Math Functions chapter > > Signed-off-by: Randy Dunlap <rdun...@infradead.org> This all makes sense to me. Acked-by: Matthew Wilcox <mawil...@microsoft.com&g

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

On Fri, Apr 13, 2018 at 01:55:51PM -0600, Jonathan Corbet wrote: > > I believe that keeping the mm docs together will give better visibility of > > what (little) mm documentation we have and will make the updates easier. > > The documents that fit well into a certain topic could be linked there.

Re: [PATCH v2 1/2] mm: introduce ARCH_HAS_PTE_SPECIAL

On Tue, Apr 10, 2018 at 05:25:50PM +0200, Laurent Dufour wrote: > arch/powerpc/include/asm/pte-common.h | 3 --- > arch/riscv/Kconfig | 1 + > arch/s390/Kconfig | 1 + You forgot to delete

Re: [PATCH net-next 00/12] fscache: Fixes, traces and development

On Fri, Apr 06, 2018 at 11:32:11AM -0700, Linus Torvalds wrote: > On Fri, Apr 6, 2018 at 11:21 AM, Linus Torvalds > wrote: > > > > No, but if you can redo the pull request part so that the diffstat I > > get will match the diffstat I see in the pull request, that

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

On Thu, Mar 22, 2018 at 06:54:13AM -0300, Mauro Carvalho Chehab wrote: > +++ b/Documentation/process/license-rules.rst > @@ -4,15 +4,17 @@ Linux kernel licensing rules > > > The Linux Kernel is provided under the terms of the GNU General Public > -License version 2

Re: rfc: remove print_vma_addr ? (was Re: [PATCH 00/16] remove eight obsolete architectures)

On Thu, Mar 15, 2018 at 09:56:46AM -0700, Joe Perches wrote: > I have a patchset that creates a vsprintf extension for > print_vma_addr and removes all the uses similar to the > print_symbol() removal. > > This now avoids any possible printk interleaving. > > Unfortunately, without some #ifdef

Re: [PATCH] Improve mutex documentation

On Thu, Mar 15, 2018 at 03:12:30PM +0300, Kirill Tkhai wrote: > > +/** > > + * mutex_lock_killable() - Acquire the mutex, interruptible by fatal > > signals. > > Shouldn't we clarify that fatal signals are SIGKILL only? It's more complicated than it might seem (... welcome to signal handling!)

[PATCH] kernel-doc: Remove __sched markings

From: Matthew Wilcox <mawil...@microsoft.com> I find the __sched annotations unaesthetic in the kernel-doc. Remove them like we remove __inline, __weak, __init and so on. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> diff --git a/scripts/kernel-doc b/scripts/kern

[PATCH] Improve mutex documentation

On Wed, Mar 14, 2018 at 01:56:31PM -0700, Andrew Morton wrote: > My memory is weak and our documentation is awful. What does > mutex_lock_killable() actually do and how does it differ from > mutex_lock_interruptible()? From: Matthew Wilcox <mawil...@microsoft.com>

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

On Mon, Mar 05, 2018 at 02:58:21PM +1100, Tobin C. Harding wrote: > -12) When to use Acked-by: and Cc: > -- > +12) When to use Acked-by: and Cc:, and Co-Developed-by: > +--- +12) When to use Acked-by:, Cc:, and

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

From: Matthew Wilcox <mawil...@microsoft.com> Sphinx 1.7 removed sphinx.util.compat.Directive so people who have upgraded cannot build the documentation. Switch to docutils.parsers.rst.Directive which has been available since docutils 0.5 released in 2009. Bugzilla:

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

On Fri, Mar 02, 2018 at 08:42:54AM -0800, Matthew Wilcox wrote: > On Fri, Mar 02, 2018 at 06:01:50PM +0200, Jani Nikula wrote: > > On Fri, 02 Mar 2018, Takashi Iwai <ti...@suse.de> wrote: > > > The sphinx.util.compat for Directive stuff was deprecated in the > > >

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

On Fri, Mar 02, 2018 at 06:01:50PM +0200, Jani Nikula wrote: > On Fri, 02 Mar 2018, Takashi Iwai wrote: > > The sphinx.util.compat for Directive stuff was deprecated in the > > recent Sphinx version, and now we get a build error. > > > > Let's import from the new place,

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

On Fri, Mar 02, 2018 at 04:28:31PM +0100, Takashi Iwai wrote: > from docutils.parsers.rst import directives > -from sphinx.util.compat import Directive > +try: > +from docutils.parsers.rst import directives, Directive We also don't need 'directives' on this line as it was imported on the

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

On Fri, Mar 02, 2018 at 12:49:03PM +0100, Takashi Iwai wrote: > I'm no expert of sphinx nor python, so something might be wrong. > Please check it. I'm also not a pythonista, but ... > --- a/Documentation/sphinx/kerneldoc.py > +++ b/Documentation/sphinx/kerneldoc.py > @@ -37,7 +37,10 @@ import

Re: [PATCH v4] usb: core: Add "quirks" parameter for usbcore

On Thu, Mar 01, 2018 at 12:01:40AM +0800, Kai Heng Feng wrote: > > Also, you won't need to use a linked list for this; you can just allocate > > an array of quirks. > > I use linked list because the total quirks number is known after the entire > string gets parsed. > Do you suggest that I should

Re: [PATCH v4] usb: core: Add "quirks" parameter for usbcore

On Mon, Feb 26, 2018 at 11:04:57PM +0800, Kai-Heng Feng wrote: > +static char quirks_param[128]; > +module_param_string(quirks, quirks_param, sizeof(quirks_param), 0644); > +MODULE_PARM_DESC(quirks, "Add/modify USB quirks by specifying > quirks=vendorID:productID:quirks"); > + > +static char

Re: [PATCH v3] usb: core: Add "quirks" parameter for usbcore

On Sun, Feb 25, 2018 at 08:38:33PM +0800, Kai-Heng Feng wrote: > v2: Use in-kernel tolower() function. ... why are you using tolower at all? You've got 13 quirks already; you may need to use upper case as well before too long. > + quirk = vmalloc(sizeof(struct quirk_entry));

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

On Tue, Feb 20, 2018 at 04:54:44PM +0200, Mike Rapoport wrote: > level. > > +Running the ``kernel-doc`` tool with increased verbosity and without actual > +output generation may be used to verify proper formating of the "formatting" > +documentation comments. For example:: > + > +

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

On Mon, Feb 19, 2018 at 10:55:50PM +0900, Masanari Iida wrote: > Driver and Controller APIs: > --- > +--- > .. kernel-doc:: include/linux/slimbus.h Is this the right fix? Shouldn't we rather delete the : instead? We don't normally have a colon at

Re: [patch 1/2] mm, page_alloc: extend kernelcore and movablecore for percent

On Fri, Feb 16, 2018 at 10:08:28AM -0600, Christopher Lameter wrote: > On Fri, 16 Feb 2018, Matthew Wilcox wrote: > > I don't understand this response. I'm not suggesting mixing objects > > of different sizes within the same page. The vast majority of slabs > > use order-0 p

Re: [patch 1/2] mm, page_alloc: extend kernelcore and movablecore for percent

On Fri, Feb 16, 2018 at 09:44:25AM -0600, Christopher Lameter wrote: > On Thu, 15 Feb 2018, Matthew Wilcox wrote: > > What I was proposing was an intermediate page allocator where slab would > > request 2MB for its own uses all at once, then allocate pages from that to > >

Re: [patch 1/2] mm, page_alloc: extend kernelcore and movablecore for percent

On Thu, Feb 15, 2018 at 09:49:00AM -0600, Christopher Lameter wrote: > On Thu, 15 Feb 2018, Matthew Wilcox wrote: > > What if ... on startup, slab allocated a MAX_ORDER page for itself. > > It would then satisfy its own page allocation requests from this giant > > page. I

Re: [patch 1/2] mm, page_alloc: extend kernelcore and movablecore for percent

On Thu, Feb 15, 2018 at 09:49:00AM -0600, Christopher Lameter wrote: > On Thu, 15 Feb 2018, Matthew Wilcox wrote: > > > What if ... on startup, slab allocated a MAX_ORDER page for itself. > > It would then satisfy its own page allocation requests from this giant > > page.

Re: [patch 1/2] mm, page_alloc: extend kernelcore and movablecore for percent

On Thu, Feb 15, 2018 at 03:45:25PM +0100, Michal Hocko wrote: > > When the amount of kernel > > memory is well bounded for certain systems, it is better to aggressively > > reclaim from existing MIGRATE_UNMOVABLE pageblocks rather than eagerly > > fallback to others. > > > > We have additional

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

On Tue, Feb 13, 2018 at 01:03:18PM -0800, Randy Dunlap wrote: > On 02/13/2018 12:59 PM, Jonathan Corbet wrote: > > I think this makes sense to do, but I really would like to see an intro > > comment on the split-man.pl script itself. Somebody wandering through > > the scripts directory should be

[PATCH v2 4/5] Fix whitespace in example

From: Matthew Wilcox <mawil...@microsoft.com> Line up the second line in the way that the example purports to be showing. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/doc-guide/kernel-doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)

[PATCH v2 3/5] Add scripts/split-man.pl

From: Matthew Wilcox <mawil...@microsoft.com> Instead of asking the user to copy and paste a small perl script from the documentation, just distribute the perl script in the scripts directory. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/doc-guide/kernel-

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

From: Matthew Wilcox <mawil...@microsoft.com> I found the layout confusing with multiple introductions to what kernel-doc is and how to use it. I made the following changes: - Moved the 'Including kernel-doc comments' section to the end of the document -- we should explai

[PATCH v2 2/5] Minor fixes to kernel-doc.rst

From: Matthew Wilcox <mawil...@microsoft.com> The author clearly meant to use the word 'which' here. Also replace some tabs with spaces which fixes the syntax highlighting in my editor. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/doc-guide/kernel-

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

From: Matthew Wilcox <mawil...@microsoft.com> Jon asked me to redo the Context: patch on top of his current docs tree. Unfortunately, I was on a plane at the time, so I started fixing some other small things, and before I knew it, I'd completely restructured the entire doc-guide/kernel-d

[PATCH v2 1/5] Add documentation for Context section

From: Matthew Wilcox <mawil...@microsoft.com> This section is mentioned in scripts/kernel-doc, so we should mention it in doc-guide/kernel-doc.rst. There are close to 500 comments using the Context section already, and almost 300 using a Locking section which fulfills much the same p

[PATCH 1/6] Add documentation for Context section

From: Matthew Wilcox <mawil...@microsoft.com> This section is mentioned in scripts/kernel-doc, so we should mention it in doc-guide/kernel-doc.rst. There are close to 500 comments using the Context section already, and almost 300 using a Locking section which fulfills much the same p

[PATCH 5/6] Restructure kernel-doc.rst

From: Matthew Wilcox <mawil...@microsoft.com> I found the layout confusing with multiple introductions to what kernel-doc is and how to use it. I made the following changes: - Moved the 'Including kernel-doc comments' section to the end of the document -- we should explai

[PATCH 3/6] Add scripts/split-man.pl

From: Matthew Wilcox <mawil...@microsoft.com> Instead of asking the user to copy and paste a small perl script from the documentation, just distribute the perl script in the scripts directory. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/doc-guide/kernel-

[PATCH 6/6] Add a Style Guide section

From: Matthew Wilcox <mawil...@microsoft.com> Let's try to be consistent and copy each other's best practices. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/doc-guide/kernel-doc.rst | 42 ++ 1 file changed, 42 insertions(+)

[PATCH 2/6] Minor fixes to kernel-doc.rst

From: Matthew Wilcox <mawil...@microsoft.com> The author clearly meant to use the word 'which' here. Also replace some tabs with spaces which fixes the syntax highlighting in my editor. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/doc-guide/kernel-

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

From: Matthew Wilcox <mawil...@microsoft.com> Jon asked me to redo the Context: patch on top of his current docs tree. Unfortunately, I was on a plane at the time, so I started fixing some other small things, and before I knew it, I'd completely restructured the entire doc-guide/kernel-d

[PATCH] Mention kernel-doc Context section

From: Matthew Wilcox <mawil...@microsoft.com> The scripts/kernel-doc processor mentions the ability to add arbitrary section names and suggests including a Context: section. We already have about 450 Context: sections in the kernel, so document it. We also have around 250 Locking: se

[PATCH] Documentation: Fix misconversion of #if

From: Matthew Wilcox <mawil...@microsoft.com> At some stage of the conversion pipeline, something thought that the DocBook entity should be rendered as NUM instead of #. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- Documentation/kernel-hacking/hacking.rst | 4 ++-- 1

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

On Sat, Jan 06, 2018 at 11:09:08AM -0700, Jonathan Corbet wrote: > On Tue, 2 Jan 2018 13:04:31 -0800 > Matthew Wilcox <wi...@infradead.org> wrote: > > > > +When replacing the group list, the new list must be sorted before it > > > +is added to the credential, a

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

On Wed, Jan 03, 2018 at 08:01:15AM +1100, NeilBrown wrote: > > +When replacing the group list, the new list must be sorted before it > +is added to the credential, as a binary search is used to test for > +membership. In practice, this means ``groups_sort()`` should be For a .rst file,

[PATCH v2] errseq: Add to documentation tree

From: Matthew Wilcox <mawil...@microsoft.com> - Move errseq.rst into core-api - Add errseq to the core-api index - Promote the header to a more prominent header type, otherwise we get three entries in the table of contents. - Reformat the table to look nicer and be a littl

Re: [PATCH] Add errseq_t documentation to the tree

On Fri, Dec 22, 2017 at 08:29:34AM -0500, Jeff Layton wrote: > > +++ b/Documentation/core-api/index.rst > > @@ -22,6 +22,7 @@ Core utilities > > flexible-arrays > > librs > > genalloc > > + ../errseq > > > > Should we also move the file into core-api/ dir? I was wondering the same

[PATCH] Add errseq_t documentation to the tree

(the SF bit is still disproportionately large, but there's no way to fix that). Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index eb16ba30aeb6..b8ec120c24f9 100644 --- a/Documentation/core-api/index.rst

Documentation license

I've written a couple of thousand words of documentation for the XArray. I need to decide how to license it. There are no SPDX tags in Documentation/ to date, so I have no examples to crib from. 1. How does one add an SPDX tag to an rst file? 2. What license should I use? I'd like people to

Re: [PATCH] Check all .c files for bad kernel-doc comments

On Mon, Oct 30, 2017 at 05:19:18PM +0200, Jani Nikula wrote: > Related, there was also a script to do reStructuredText lint style > checks in addition to the kernel-doc checks using make CHECK and > C=1. See http://mid.mail-archive.com/87h98quc1w.fsf@intel.com I don't really care which patch goes

Re: [PATCH] Check all .c files for bad kernel-doc comments

On Mon, Oct 30, 2017 at 12:40:20PM +0900, Masahiro Yamada wrote: > 2017-10-28 4:41 GMT+09:00 Matthew Wilcox <wi...@infradead.org>: > > Implement a '-none' output mode for kernel-doc which will only output > > warning messages, and suppresses the warning message about there be

[PATCH] Check all .c files for bad kernel-doc comments

From: Matthew Wilcox <mawil...@microsoft.com> Implement a '-none' output mode for kernel-doc which will only output warning messages, and suppresses the warning message about there being no kernel-doc in the file. Add it to the rule to build .o files from .c files, so it will check all .c

Re: [PATCH] Documentation: filesystems: update filesystem locking documentation

On Mon, Jul 31, 2017 at 11:53:35AM -0400, Sean Anderson wrote: > - i_mutex(inode) > -lookup: yes > + i_rwsem(inode) > +lookup: shared > create: yes Could you change all the 'yes' to 'exclusive' when it's changed from mutex to rwsem?

Re: [PATCH 1/4] fs/dcache: Limit numbers of negative dentries

On Mon, Jul 17, 2017 at 09:39:30AM -0400, Waiman Long wrote: > The number of positive dentries is limited by the number of files > in the filesystems. The number of negative dentries, however, > has no limit other than the total amount of memory available in > the system. So a rogue application

Re: [PATCH 2/4] fs/dcache: Report negative dentry number in dentry-state

On Mon, Jul 17, 2017 at 09:39:31AM -0400, Waiman Long wrote: > @@ -63,9 +63,10 @@ struct qstr { > struct dentry_stat_t { > long nr_dentry; > long nr_unused; > - long age_limit; /* age in seconds */ > - long want_pages; /* pages requested by system */ > -

[PATCH] Improve sparse documentation

Add documentation of -DCONFIG_SPARSE_RCU_POINTER. I started to add documentation of -D__CHECK_ENDIAN__ as well, but discovered I'm too late; that's now enabled by default. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> diff --git a/Documentation/dev-tools/sparse.rst b/Documentati

[PATCH] Add 'nodoc' option

rom 26896bd43618e30cb3563114663ad6c39cef7dc6 Mon Sep 17 00:00:00 2001 From: Matthew Wilcox <mawil...@microsoft.com> Date: Thu, 26 Jan 2017 11:43:24 -0500 Subject: [PATCH] kerneldoc: Add :nodoc: option This is functionality the perl script already has, we just need to expose it to our

RE: Omitting documentation for internal structure members

From: Jani Nikula [mailto:jani.nik...@linux.intel.com] > You can use /* private: */ within the struct to indicate the following > members should not be included in the generated documentation. It does > however mean you can't then document the members either, or you'll get > warnings. > > I'm

Omitting documentation for internal structure members

Here's a little glitch that I'd like to see fixed: struct radix_tree_iter radix tree iterator state Definition struct radix_tree_iter { unsigned long index; unsigned long next_index; unsigned long tags; struct radix_tree_node * node; #ifdef CONFIG_RADIX_TREE_MULTIORDER unsigned int

RE: [PATCH] kernel-doc: Handle returning pointers to pointers

From: Markus Heiser [mailto:markus.hei...@darmarit.de] > Am 23.01.2017 um 16:24 schrieb Jonathan Corbet : > > Markus, would you consider sending out a new patch set for review? > > Yes, I send RFC soon ... Could I ask for some features? I'd've been trying to add them to the perl

RE: [PATCH] kernel-doc: Handle returning pointers to pointers

From: Markus Heiser [mailto:markus.hei...@darmarit.de] > Am 23.01.2017 um 09:18 schrieb Matthew Wilcox > <mawil...@microsoft.com>: > Hi Matthew ! > > short answer: Thanks a lot > Acked-by: Markus Heiser <markus.hei...@darmarit.de> Excellent! > to be more

[PATCH] kernel-doc: Handle returning pointers to pointers

-or-more. I have tried to fix that, but now I have perl regexes all over my hands, and I fear I shall never be clean again. Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> --- scripts/kernel-doc | 14 +++--- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/s