Re: [PATCH 2/2] Documentation: kdump: describe VMCOREINFO export for RISCV64

Conor Dooley
2022-10-14T13:10:43Z

Hey Bagas,

On Fri, Oct 14, 2022 at 08:01:32PM +0700, Bagas Sanjaya wrote:
> On Fri, Oct 14, 2022 at 03:48:10PM +0800, Xianting Tian wrote:
> > The following interrelated definitions and ranges are needed by the kdump
> > crash tool, they are exported by "arch/riscv/kernel/crash_core.c":
> > VA_BITS,
> > PAGE_OFFSET,
> > phys_ram_base,
> > MODULES_VADDR ~ MODULES_END,
> > VMALLOC_START ~ VMALLOC_END,
> > VMEMMAP_START ~ VMEMMAP_END,
> > KASAN_SHADOW_START ~ KASAN_SHADOW_END,
> > KERNEL_LINK_ADDR ~ ADDRESS_SPACE_END
> >
> > Document these RISCV64 exports above.
> >
>
> The patch description LGTM, thanks.
>
> > +----------------------------------------------------------------------------------------------------------------------------------------------------
> > +MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
> > +----------------------------------------------------------------------------------------------------------------------------------------------------
>
> The overline above header text is unnecessary, so I have to strip it:
>
> ---- >8 ----
>
> diff --git a/Documentation/admin-guide/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> index 6c7a1728de220e..8e2e164cf3db49 100644
> --- a/Documentation/admin-guide/kdump/vmcoreinfo.rst
> +++ b/Documentation/admin-guide/kdump/vmcoreinfo.rst
> @@ -615,7 +615,6 @@ phys_ram_base
>
> Indicates the start physical RAM address.
>
> -----------------------------------------------------------------------------------------------------------------------------------------------------
> MODULES_VADDR|MODULES_END|VMALLOC_START|VMALLOC_END|VMEMMAP_START|VMEMMAP_END|KASAN_SHADOW_START|KASAN_SHADOW_END|KERNEL_LINK_ADDR|ADDRESS_SPACE_END
> ----------------------------------------------------------------------------------------------------------------------------------------------------

Without whitespace highlighting, your change threw me for a sec.. But
yeah, having the overline is inconsistent with other headings in the
doc.

What I wanted to ask about was the linelength as I don't know anything
about rst. Is it possible to avoid having the ~150 character line or is
that a necessary evil?

Thanks,
Conor.

>
> Thanks.
>
> --
> An old man doll... just what I always wanted! - Clara