Re: [PATCH] docs: arm64: Fix indentation and doc formatting

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, Sep 28, 2019 at 10:58:19PM +1000, Adam Zerella wrote:
> Sphinx generates the following warnings for the arm64 doc
> pages:
> 
> Documentation/arm64/memory.rst:158: WARNING: Unexpected indentation.
> Documentation/arm64/memory.rst:162: WARNING: Unexpected indentation.
> 
> These indentations warnings can be resolved by utilising code
> hightlighting instead.
> 
> Signed-off-by: Adam Zerella <adam.zerella@xxxxxxxxx>
> ---
>  Documentation/arm64/memory.rst | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/arm64/memory.rst b/Documentation/arm64/memory.rst
> index b040909e45f8..f7db6a3898c5 100644
> --- a/Documentation/arm64/memory.rst
> +++ b/Documentation/arm64/memory.rst
> @@ -154,11 +154,16 @@ return virtual addresses to userspace from a 48-bit range.
>  
>  Software can "opt-in" to receiving VAs from a 52-bit space by
>  specifying an mmap hint parameter that is larger than 48-bit.
> -For example:
> -    maybe_high_address = mmap(~0UL, size, prot, flags,...);
> +
> +.. code-block:: c
> +
> +   maybe_high_address = mmap(~0UL, size, prot, flags,...);

Why did you drop the "For example:" prefix?

Will



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux