Re: [PATCH 00/16] remove eight obsolete architectures

[David Howells]

Do we have anything left that still implements NOMMU?

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] KEYS: fix in-kernel documentation for keyctl_read()

[David Howells]

Eric Biggers  wrote:

> I guess that's fine --- either way users can't rely on the contents of the
> buffer.  The man page should use the same wording, though.  Should I send a v2
> of both patches?

Please.  I just think it's better to put the 'semi-successful' case before the
'really successful' case.

Thanks.
David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] KEYS: fix in-kernel documentation for keyctl_read()

[David Howells]

Eric Biggers  wrote:

> - As much of the data as can be fitted into the buffer will be copied to
> - userspace if the buffer pointer is not NULL.
> -
> - On a successful return, the function will always return the amount of 
> data
> - available rather than the amount copied.
> + On success, the function will return the amount of data placed into the
> + buffer.
>  
> + If the specified buffer is too small, then the size of the buffer 
> required
> + will be returned, and it is unspecified whether any data will be copied
> + into the buffer.

How about:

 If the specified buffer is too small, then the size of the buffer
 required will be returned.  Note that, in this case, the contents of the
 buffer may be have been overwritten in some undefined way.

 Otherwise, on success, the function will return the amount of data copied
 into the buffer.

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups

[David Howells]

Mauro Carvalho Chehab  wrote:

> - *   calling skb_free_datagram). Returns NULL with *err set to
> + *   calling skb_free_datagram). Returns NULL with @err set to

I think this should be *@err or @*err.  err is not itself changed.

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v5 01/32] x86: Documentation for AMD Secure Memory Encryption (SME)

[David Howells]

Borislav Petkov  wrote:

> "Subject: [PATCH v5 01/32] x86: Add documentation for AMD Secure Memory 
> Encryption (SME)"

Or:

x86: Document AMD Secure Memory Encryption (SME) support

David
--
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  http://vger.kernel.org/majordomo-info.html

[no subject]

[David Howells]

> -header-y += msr-index.h

I see it on my desktop as /usr/include/asm/msr-index.h and it's been there at
least four years - and as such it's part of the UAPI.  I don't think you can
remove it unless you can guarantee there are no userspace users.

David
--
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  http://vger.kernel.org/majordomo-info.html

[no subject]

[David Howells]

Nicolas Dichtel  wrote:

> This header file is exported, thus move it to uapi.

Exported how?

> +#ifdef __INT32_TYPE__
> +#undef __INT32_TYPE__
> +#define __INT32_TYPE__   int
> +#endif
> +
> +#ifdef __UINT32_TYPE__
> +#undef __UINT32_TYPE__
> +#define __UINT32_TYPE__  unsigned int
> +#endif
> +
> +#ifdef __UINTPTR_TYPE__
> +#undef __UINTPTR_TYPE__
> +#define __UINTPTR_TYPE__ unsigned long
> +#endif

These weren't defined by the kernel before, so why do we need to define them
now?

Will defining __UINTPTR_TYPE__ cause problems in compiling libboost by
changing the signature on C++ functions that use uintptr_t?

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] Documentation: circular-buffers: use READ_ONCE()

[David Howells]

Mark Rutland <mark.rutl...@arm.com> wrote:

> While the {READ,WRITE}_ONCE() macros should be used in preference to
> ACCESS_ONCE(), the circular buffer documentation uses the latter
> exclusively.
> 
> To point people in the right direction, and as a step towards the
> eventual removal of ACCESS_ONCE(), update the documentation to use
> READ_ONCE(), as ACCESS_ONCE() is only used in a reader context in the
> circular buffer documentation.
> 
> Signed-off-by: Mark Rutland <mark.rutl...@arm.com>
> Cc: Jonathan Corbet <cor...@lwn.net>
> Cc: Paul E. McKenney <paul...@linux.vnet.ibm.com>
> Cc: linux-doc@vger.kernel.org
> Cc: linux-ker...@vger.kernel.org

Acked-by: David Howells <dhowe...@redhat.com>
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 16/37] Documentation/module-signing.txt: convert to ReST markup

[David Howells]

Mauro Carvalho Chehab  wrote:

> - Fix identatio for the document title;
> - remove its index;
> - create a table for hash algorithm to be used;
> - use quote blocks where needed;
> - use monotonic fonts for parameters;
> - adjust whitespaces and blank lines;
> - Fix case on section titles;
> - add it to the user's book.

Hmmm... I'm not entirely convinced that these changes are an improvement.  The
main usage of this file is as a text file, but the index has been removed and
it's now got weird markups in it that reduce the readability.

Can you please at least return the index?  If these files are no longer meant
to be read as text files, why don't we just bite the bullet and convert the
whole lot to latex, docbook or texinfo?

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] modsign: Fix documentation on module signing enforcement parameter.

[David Howells]

Reviewed-by: David Howells <dhowe...@redhat.com>
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 3/5] doc/memory-barriers: fix typo

[David Howells]

SeongJae Park <sj38.p...@gmail.com> wrote:

> Signed-off-by: SeongJae Park <sj38.p...@gmail.com>

Acked-by: David Howells <dhowe...@redhat.com>
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/5] doc/memory-barriers: add missed subsection in TOC

[David Howells]

SeongJae Park <sj38.p...@gmail.com> wrote:

> Virtual Machine Guests subsection has added with commit
> 6a65d26385bf487926a0616650927303058551e3 ("asm-generic: implement
> virt_xxx memory barriers") in memory-barriers.txt but it forgot to add
> the subsection in 'table of contents'.  This commit adds the subsection
> in the 'table of contents'.
> 
> Signed-off-by: SeongJae Park <sj38.p...@gmail.com>

Acked-by: David Howells <dhowe...@redhat.com>
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 4/5] doc/memory-barriers: Insert white spaces consistently

[David Howells]

SeongJae Park <sj38.p...@gmail.com> wrote:

> The document uses two newlines between sections, one newline between
> item and its detailed description, and two spaces between sentences.
> However, there is few point that missed the rule.  This commit fix them
> to use the rule consistently.
> 
> Signed-off-by: SeongJae Park <sj38.p...@gmail.com>

Excellent, thanks!  It's something I've been meaning to do for a while.

Acked-by: David Howells <dhowe...@redhat.com>
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 1/5] doc/memory-barriers: fix missed renaming: s/lock/acquire

[David Howells]

SeongJae Park  wrote:

> - - Locking functions.
> + - Acquiring functions.

Actually, this should be 'locking' functions.  If you look at the text:

ACQUIRING FUNCTIONS
---

The Linux kernel has a number of locking constructs:

 (*) spin locks
 (*) R/W spin locks
 (*) mutexes
 (*) semaphores
 (*) R/W semaphores

It's specifically talking about locking functions that the kernel provides -
or are we calling the spin acquires and R/W spin acquires now?  "Locking" is
the key that people referring to the document are going to use.

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] modsign: Fix documentation on module signing enforcement parameter.

[David Howells]

James Johnston  wrote:

> -If CONFIG_MODULE_SIG_FORCE is enabled or enforcemodulesig=1 is supplied on
> +If CONFIG_MODULE_SIG_FORCE is enabled or module.sig_enforce=1 is supplied

You're definitely right about the change from enforcemodulesig to sig_enforce,
but how does the "module." come about?

David
--
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  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] Documentation/memory-barriers: fix wrong comment in example

[David Howells]

SeongJae Park  wrote:

>   a = 0;
>   /* Code that does not store to variable a. */
> + does_not_change_a();
>   a = 0;

Since it's not actually code that's meant to be executed, you could make it:

a = 0;
... code that does not store to variable a ...
a = 0;

David
--
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  http://vger.kernel.org/majordomo-info.html