Re: [PATCH v3 2/3] doc: update kpt_restrict documentation

On Mon, Dec 18, 2017 at 03:50:06PM -0800, Randy Dunlap wrote: > On 12/18/2017 02:29 PM, Tobin C. Harding wrote: > > Recently the behaviour of printk specifier %pK was changed. The > > documentation does not currently mirror this. > > > > Update documentation for sysctl kpt_restrict. > > Fix

[RFC PATCH] mm: memcontrol: memory+swap accounting for cgroup-v2

The memory controller in cgroup v1 provides the memory+swap (memsw) interface to account to the combined usage of memory and swap of the jobs. The memsw interface allows the users to limit or view the consistent memory usage of their jobs irrespectibe of the presense of swap on the system

Re: [PATCH v3 2/3] doc: update kpt_restrict documentation

On 12/18/2017 02:29 PM, Tobin C. Harding wrote: > Recently the behaviour of printk specifier %pK was changed. The > documentation does not currently mirror this. > > Update documentation for sysctl kpt_restrict. Fix subject and here . > > Signed-off-by: Tobin C.

Re: [PATCH v9 29/51] mm/mprotect, powerpc/mm/pkeys, x86/mm/pkeys: Add sysfs interface

On Mon, Dec 18, 2017 at 02:28:14PM -0800, Dave Hansen wrote: > On 12/18/2017 02:18 PM, Ram Pai wrote: > > b) minimum number of keys available to the application. > > if libraries consumes a few, they could provide a library > > interface to the application informing the number available to

[PATCH v3 2/3] doc: update kpt_restrict documentation

Recently the behaviour of printk specifier %pK was changed. The documentation does not currently mirror this. Update documentation for sysctl kpt_restrict. Signed-off-by: Tobin C. Harding --- Documentation/sysctl/kernel.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)

[PATCH v3 1/3] doc: convert printk-formats.txt to rst

Documentation/printk-formats.txt is a candidate for conversion to ReStructuredText format. Some effort has already been made to do this conversion even thought the suffix is currently .txt Changes required to complete conversion - Move printk-formats.txt to core-api/printk-formats.rst - Add

[PATCH v3 3/3] doc: add documentation on printing kernel addresses

Hashing addresses printed with printk specifier %p was implemented recently. During development a number of issues were raised regarding leaking kernel addresses to userspace. Other documentation was updated but security/self-protection missed out. Add self-protection documentation regarding

[PATCH v3 0/3] doc: update printk documentation

This set converts printk-formats.txt -> core-api/printk-formats.rst We also update the documentation around printing kernel addresses. This is my first documentation conversion. Please do be hard on this patch series. I'd like to get it _really_ correct so that future conversions will require

Re: [PATCH v9 29/51] mm/mprotect, powerpc/mm/pkeys, x86/mm/pkeys: Add sysfs interface

On 12/18/2017 02:18 PM, Ram Pai wrote: > b) minimum number of keys available to the application. > if libraries consumes a few, they could provide a library > interface to the application informing the number available to > the application. The library interface can leverage (b)

Re: [PATCH v9 29/51] mm/mprotect, powerpc/mm/pkeys, x86/mm/pkeys: Add sysfs interface

On Mon, Dec 18, 2017 at 10:54:26AM -0800, Dave Hansen wrote: > On 11/06/2017 12:57 AM, Ram Pai wrote: > > Expose useful information for programs using memory protection keys. > > Provide implementation for powerpc and x86. > > > > On a powerpc system with pkeys support, here is what is shown: > >

Re: [PATCH] Documentation/filesystems/vfat.txt: fix a remark that implies UCS2

Adam Borowski writes: > All non-historic operating systems support the full range of Unicode here, > thus you can make filenames for example in Gothic (̴̼͉ͅ), the other Gothic > (퓂ℯℴ퓌) or the third Gothic (헆햾허헐), or declare something as . > > Characters above U+ are

[PATCH] Documentation/filesystems/vfat.txt: fix a remark that implies UCS2

All non-historic operating systems support the full range of Unicode here, thus you can make filenames for example in Gothic (̴̼͉ͅ), the other Gothic (퓂ℯℴ퓌) or the third Gothic (헆햾허헐), or declare something as . Characters above U+ are encoded on four bytes. Signed-off-by: Adam Borowski

Re: [PATCH 15/24] media: v4l2-subdev: get rid of __V4L2_SUBDEV_MK_GET_TRY() macro

Em Mon, 9 Oct 2017 23:23:56 +0300 Sakari Ailus escreveu: > Hi Mauro, > > On Mon, Oct 09, 2017 at 07:19:21AM -0300, Mauro Carvalho Chehab wrote: > > The __V4L2_SUBDEV_MK_GET_TRY() macro is used to define > > 3 functions that have the same arguments. The code of those > >

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, Dec 18, 2017 at 07:39:50PM +0100, Knut Omang wrote: > On Mon, 2017-12-18 at 17:56 +, Bart Van Assche wrote: > > On Mon, 2017-12-18 at 10:46 -0700, Jason Gunthorpe wrote: > > > On Sun, Dec 17, 2017 at 10:00:17PM -0800, Joe Perches wrote: > > > > > > > > Today when we run checkers we get

Re: [PATCH v2 14/17] media: v4l2-async: better describe match union at async match struct

Em Fri, 13 Oct 2017 15:49:25 +0300 Laurent Pinchart escreveu: > Hi Mauro, > > Thank you for the patch. > > On Thursday, 28 September 2017 00:46:57 EEST Mauro Carvalho Chehab wrote: > > Now that kernel-doc handles nested unions, better document the > > match

Re: [PATCH v2 13/17] media: v4l2-async: simplify v4l2_async_subdev structure

Em Sat, 30 Sep 2017 01:05:24 +0300 Sakari Ailus escreveu: > Hi Mauro, > > (Removing the non-list recipients.) > > On Fri, Sep 29, 2017 at 06:27:13AM -0300, Mauro Carvalho Chehab wrote: > > Em Thu, 28 Sep 2017 15:09:21 +0300 > > Sakari Ailus escreveu:

Re: [PATCH v9 29/51] mm/mprotect, powerpc/mm/pkeys, x86/mm/pkeys: Add sysfs interface

On 11/06/2017 12:57 AM, Ram Pai wrote: > Expose useful information for programs using memory protection keys. > Provide implementation for powerpc and x86. > > On a powerpc system with pkeys support, here is what is shown: > > $ head /sys/kernel/mm/protection_keys/* > ==>

Re: [PATCH 04/24] media: v4l2-mediabus: convert flags to enums and document them

Em Wed, 11 Oct 2017 23:26:44 +0200 Pavel Machek escreveu: > On Mon 2017-10-09 07:19:10, Mauro Carvalho Chehab wrote: > > There is a mess with media bus flags: there are two sets of > > flags, one used by parallel and ITU-R BT.656 outputs, > > and another one for CSI2. > > > >

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, 2017-12-18 at 17:56 +, Bart Van Assche wrote: > On Mon, 2017-12-18 at 10:46 -0700, Jason Gunthorpe wrote: > > On Sun, Dec 17, 2017 at 10:00:17PM -0800, Joe Perches wrote: > > > > > > Today when we run checkers we get so many warnings it is too hard to > > > > make any sense of it. > >

Re: [PATCH v2 2/7] i3c: Add core I3C infrastructure

On 12/18/2017 12:37 AM, Boris Brezillon wrote: > On Sun, 17 Dec 2017 14:32:04 -0800 > Randy Dunlap wrote: > >> On 12/14/17 07:16, Boris Brezillon wrote: >>> Add core infrastructure to support I3C in Linux and document it. >>> >>> Signed-off-by: Boris Brezillon

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, 2017-12-18 at 10:46 -0700, Jason Gunthorpe wrote: > On Sun, Dec 17, 2017 at 10:00:17PM -0800, Joe Perches wrote: > > > > Today when we run checkers we get so many warnings it is too hard to > > > make any sense of it. > > > > Here is a list of the checkpatch messages for

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, 2017-12-18 at 10:46 -0700, Jason Gunthorpe wrote: > On Sun, Dec 17, 2017 at 10:00:17PM -0800, Joe Perches wrote: > > > > Today when we run checkers we get so many warnings it is too hard to > > > make any sense of it. > > > > Here is a list of the checkpatch messages for

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, Dec 18, 2017 at 02:05:15PM +0100, Knut Omang wrote: > https://github.com/torvalds/linux/compare/master...knuto:runchecks Several of these to rdma/core do not look so big, you should think about sending them.. Jason -- To unsubscribe from this list: send the line "unsubscribe linux-doc"

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Sun, Dec 17, 2017 at 10:00:17PM -0800, Joe Perches wrote: > > Today when we run checkers we get so many warnings it is too hard to > > make any sense of it. > > Here is a list of the checkpatch messages for drivers/infiniband > sorted by type. > > Many of these might be corrected by using >

Re: [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2

Em Mon, 9 Oct 2017 07:19:06 -0300 Mauro Carvalho Chehab escreveu: > That's the second part of my V4L2 kAPI documentation improvements. > It is meant to reduce the gap between the kAPI media headers > and documentation, at least with regards to kernel-doc markups. > >

Re: [PATCH 19/24] media: vb2-core: Improve kernel-doc markups

Em Tue, 10 Oct 2017 16:32:34 +0300 Sakari Ailus escreveu: > Hi Mauro, > > On Mon, Oct 09, 2017 at 07:19:25AM -0300, Mauro Carvalho Chehab wrote: > > There are several issues on the current markups: > > - lack of cross-references; > > - wrong cross-references; > > - lack of

Re: [PATCH 05/24] media: v4l2-dev: convert VFL_TYPE_* into an enum

Em Tue, 10 Oct 2017 21:47:04 +0100 Andrey Utkin escreveu: > On Mon, Oct 09, 2017 at 07:19:11AM -0300, Mauro Carvalho Chehab wrote: > > Using enums makes easier to document, as it can use kernel-doc > > markups. It also allows cross-referencing, with increases the > >

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, 2017-12-18 at 07:30 -0800, Joe Perches wrote: > On Mon, 2017-12-18 at 14:05 +0100, Knut Omang wrote: > > > Here is a list of the checkpatch messages for drivers/infiniband > > > sorted by type. > > > > > > Many of these might be corrected by using > > > > > > $ ./scripts/checkpatch.pl -f

Re: [PATCH v2 08/17] media: v4l2-ioctl.h: convert debug macros into enum and document

Hi Mauro, On Monday, 18 December 2017 17:13:26 EET Mauro Carvalho Chehab wrote: > Em Fri, 13 Oct 2017 15:38:11 +0300 Laurent Pinchart escreveu: > > On Thursday, 28 September 2017 00:46:51 EEST Mauro Carvalho Chehab wrote: > >> Currently, there's no way to document #define foo > >> with

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Mon, 2017-12-18 at 14:05 +0100, Knut Omang wrote: > > Here is a list of the checkpatch messages for drivers/infiniband > > sorted by type. > > > > Many of these might be corrected by using > > > > $ ./scripts/checkpatch.pl -f --fix-inplace --types= \ > > $(git ls-files drivers/infiniband/)

Re: [PATCH v3 00/17] kernel-doc: add supported to document nested structs/

Em Wed, 4 Oct 2017 08:48:38 -0300 Mauro Carvalho Chehab escreveu: > Right now, it is not possible to document nested struct and nested unions. > kernel-doc simply ignore them. > > Add support to document them. > > Patches 1 to 6 improve kernel-doc documentation to

Re: [PATCH v2 08/17] media: v4l2-ioctl.h: convert debug macros into enum and document

Em Fri, 13 Oct 2017 15:38:11 +0300 Laurent Pinchart escreveu: > Hi Mauro, > > Thank you for the patch. > > On Thursday, 28 September 2017 00:46:51 EEST Mauro Carvalho Chehab wrote: > > Currently, there's no way to document #define foo > > with kernel-doc.

Re: [PATCH v2 05/17] media: v4l2-device.h: document ancillary macros

Em Fri, 13 Oct 2017 15:33:01 +0300 Laurent Pinchart escreveu: > Hi Mauro, > > Thank you for the patch. > > On Thursday, 28 September 2017 00:46:48 EEST Mauro Carvalho Chehab wrote: > > There are several widely macros that aren't documented using kernel-docs

Re: [PATCH v2 02/17] media: v4l2-common: get rid of v4l2_routing dead struct

On Mon, Dec 18, 2017 at 12:11:13PM -0200, Mauro Carvalho Chehab wrote: > Em Fri, 13 Oct 2017 15:24:34 +0200 > Hans Verkuil escreveu: > > > > --- > > > include/media/v4l2-common.h | 14 +- > > > 1 file changed, 5 insertions(+), 9 deletions(-) > > > > > > diff

Re: [PATCH v2 02/17] media: v4l2-common: get rid of v4l2_routing dead struct

Em Fri, 13 Oct 2017 15:24:34 +0200 Hans Verkuil escreveu: > > --- > > include/media/v4l2-common.h | 14 +- > > 1 file changed, 5 insertions(+), 9 deletions(-) > > > > diff --git a/include/media/v4l2-common.h b/include/media/v4l2-common.h > > @@ -238,11 +239,6 @@

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Sun, 2017-12-17 at 22:00 -0700, Jason Gunthorpe wrote: > On Sun, Dec 17, 2017 at 03:14:10AM +0100, Knut Omang wrote: > > > > I like the ability to add more checkers and keep then in the main > > > upstream tree. But adding overrides for specific subsystems goes against > > > the policy that

Re: [PATCH v2 0/5] Support for generalized use of make C={1,2} via a wrapper program

On Sun, 2017-12-17 at 22:00 -0800, Joe Perches wrote: > On Sun, 2017-12-17 at 22:00 -0700, Jason Gunthorpe wrote: > > On Sun, Dec 17, 2017 at 03:14:10AM +0100, Knut Omang wrote: > > > > > > I like the ability to add more checkers and keep then in the main > > > > upstream tree. But adding

[PATCH v4 06/18] docs: kernel-doc.rst: add documentation about man pages

kernel-doc-nano-HOWTO.txt has a chapter about man pages production. While we don't have a working "make manpages" target, add it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 34 ++ 1 file changed,

[PATCH v4 04/18] docs: kernel-doc.rst: improve structs chapter

There is a mess on this chapter: it suggests that even enums and unions should be documented with "struct". That's not the way it should be ;-) Fix it and move it to happen earlier. Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 48

[PATCH v4 10/18] scripts: kernel-doc: change default to ReST format

Right now, if kernel-doc is called without arguments, it defaults to man pages. IMO, it makes more sense to default to ReST, as this is the output that it is most used nowadays, and it easier to check if everything got parsed fine on an enriched text mode format. Signed-off-by: Mauro Carvalho

[PATCH v4 13/18] scripts: kernel-doc: get rid of $nested parameter

The check_sections() function has a $nested parameter, meant to identify when a nested struct is present. As we now have a logic that handles it, get rid of such parameter. Suggested-by: Markus Heiser Signed-off-by: Mauro Carvalho Chehab ---

[PATCH v4 16/18] scripts: kernel-doc: improve nested logic to handle multiple identifiers

It is possible to use nested structs like: struct { struct { void *arg1; } st1, st2, *st3, st4; }; Handling it requires to split each parameter. Change the logic to allow such definitions. In order to test the new nested logic, the following file was used to test

[PATCH v4 03/18] docs: kernel-doc.rst: improve function documentation section

Move its contents to happen earlier and improve the description of return values, adding a subsection to it. Most of the contents there came from kernel-doc-nano-HOWTO.txt. Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 100

[PATCH v4 18/18] w1_netlink.h: add support for nested structs

Now that kernel-doc can hanle nested structs/unions, describe such fields at w1_netlink_message_types. Acked-by: Evgeniy Polyakov Signed-off-by: Mauro Carvalho Chehab --- drivers/w1/w1_netlink.h | 6 +- 1 file changed, 5 insertions(+), 1

[PATCH v4 09/18] scripts: kernel-doc: improve argument handling

Right now, if one uses "--rst" instead of "-rst", it just ignore the argument and produces a man page. Change the logic to accept both "-cmd" and "--cmd". Also, if "cmd" doesn't exist, print the usage information and exit. Signed-off-by: Mauro Carvalho Chehab ---

[PATCH v4 12/18] scripts: kernel-doc: parse next structs/unions

There are several places within the Kernel tree with nested structs/unions, like this one: struct ingenic_cgu_clk_info { const char *name; enum { CGU_CLK_NONE = 0, CGU_CLK_EXT = BIT(0), CGU_CLK_PLL = BIT(1), CGU_CLK_GATE = BIT(2), CGU_CLK_MUX = BIT(3),

[PATCH v4 08/18] scripts: kernel-doc: get rid of unused output formats

Since there isn't any docbook code anymore upstream, we can get rid of several output formats: - docbook/xml, html, html5 and list formats were used by the old build system; - As ReST is text, there's not much sense on outputting on a different text format. After this patch, only man and rst

[PATCH v4 00/18] kernel-doc: add supported to document nested structs

Hi Jon, This is a rebased version of my patch series that add support for nested structs on kernel-doc. With this version, it won't produce anymore hundreds of identical warnings, as patch 17 removes the warning duplication. Excluding warnings about duplicated Note: section at hash.h, before

[PATCH v4 05/18] docs: kernel-doc.rst: improve typedef documentation

Add documentation about typedefs for function prototypes and move it to happen earlier. Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 32 ++-- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git

[PATCH v4 01/18] docs: kernel-doc.rst: better describe kernel-doc arguments

Add a new section to describe kernel-doc arguments, adding examples about how identation should happen, as failing to do that causes Sphinx to do the wrong thing. Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 44

[PATCH v4 07/18] docs: get rid of kernel-doc-nano-HOWTO.txt

Everything there is already described at Documentation/doc-guide/kernel-doc.rst. So, there's no reason why to keep it anymore. Signed-off-by: Mauro Carvalho Chehab --- Documentation/00-INDEX | 2 - Documentation/kernel-doc-nano-HOWTO.txt | 322

[PATCH v4 15/18] scripts: kernel-doc: handle nested struct function arguments

Function arguments are different than usual ones. So, an special logic is needed in order to handle such arguments on nested structs. Signed-off-by: Mauro Carvalho Chehab --- scripts/kernel-doc | 38 ++ 1 file changed, 26

[PATCH v4 11/18] scripts: kernel-doc: replace tabs by spaces

Sphinx has a hard time dealing with tabs, causing it to misinterpret paragraph continuation. As we're now mainly focused on supporting ReST output, replace tabs by spaces, in order to avoid troubles when the output is parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab

[PATCH v4 02/18] docs: kernel-doc.rst: improve private members description

The private members section can now be moved to be together with the arguments section. Move it there and add an example about the usage of public: Signed-off-by: Mauro Carvalho Chehab --- Documentation/doc-guide/kernel-doc.rst | 56 ++

[PATCH v4 14/18] scripts: kernel-doc: print the declaration name on warnings

The logic at create_parameterlist()'s ancillary push_parameter() function has already a way to output the declaration name, with would help to discover what declaration is missing. However, currently, the logic is utterly broken, as it uses the var $type with a wrong meaning. With the current

[PATCH v4 17/18] scripts: kernel-doc: apply filtering rules to warnings

When kernel-doc is called with output selection filters, it will be called lots of time for a single file. If there is a warning present there, it means that it may print hundreds of identical warnings. Worse than that, the -function NAME actually filters only functions. So, it makes no sense at

Re: Documentation license

On Thu, 14 Dec 2017, Matthew Wilcox wrote: > 1. How does one add an SPDX tag to an rst file? Do we want the SPDX tags visible in the generated documentation or not? If not, you have to put it in an rst comment: .. SPDX-License-Identifier: GPL-2.0 If yes, I'd go for using

Re: [PATCH v2 2/7] i3c: Add core I3C infrastructure

On Sun, 17 Dec 2017 14:32:04 -0800 Randy Dunlap wrote: > On 12/14/17 07:16, Boris Brezillon wrote: > > Add core infrastructure to support I3C in Linux and document it. > > > > Signed-off-by: Boris Brezillon > > --- > > drivers/Kconfig