Re: [PATCH 34/34] docs: x86: avoid using ReSt :doc:`foo` markup

Peter Zijlstra
2021-06-07T15:21:17Z

On Sat, Jun 05, 2021 at 03:18:33PM +0200, Mauro Carvalho Chehab wrote:
> The :doc:`foo` tag is auto-generated via automarkup.py.
> So, use the filename at the sources, instead of :doc:`foo`.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Thanks!

Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org>

> ---
> Documentation/x86/boot.rst | 4 ++--
> Documentation/x86/mtrr.rst | 2 +-
> 2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/x86/boot.rst b/Documentation/x86/boot.rst
> index fc844913dece..894a19897005 100644
> --- a/Documentation/x86/boot.rst
> +++ b/Documentation/x86/boot.rst
> @@ -1343,7 +1343,7 @@ follow::
> In addition to read/modify/write the setup header of the struct
> boot_params as that of 16-bit boot protocol, the boot loader should
> also fill the additional fields of the struct boot_params as
> -described in chapter :doc:`zero-page`.
> +described in chapter Documentation/x86/zero-page.rst.
>
> After setting up the struct boot_params, the boot loader can load the
> 32/64-bit kernel in the same way as that of 16-bit boot protocol.
> @@ -1379,7 +1379,7 @@ can be calculated as follows::
> In addition to read/modify/write the setup header of the struct
> boot_params as that of 16-bit boot protocol, the boot loader should
> also fill the additional fields of the struct boot_params as described
> -in chapter :doc:`zero-page`.
> +in chapter Documentation/x86/zero-page.rst.
>
> After setting up the struct boot_params, the boot loader can load
> 64-bit kernel in the same way as that of 16-bit boot protocol, but
> diff --git a/Documentation/x86/mtrr.rst b/Documentation/x86/mtrr.rst
> index c5b695d75349..9f0b1851771a 100644
> --- a/Documentation/x86/mtrr.rst
> +++ b/Documentation/x86/mtrr.rst
> @@ -28,7 +28,7 @@ are aligned with platform MTRR setup. If MTRRs are only set up by the platform
> firmware code though and the OS does not make any specific MTRR mapping
> requests mtrr_type_lookup() should always return MTRR_TYPE_INVALID.
>
> -For details refer to :doc:`pat`.
> +For details refer to Documentation/x86/pat.rst.
>
> .. tip::
> On Intel P6 family processors (Pentium Pro, Pentium II and later)
> --
> 2.31.1
>