Re: [PATCH 04/10] docs/scheduler/sched-bwc: add proper ref

[Jonathan Corbet <corbet@lwn.net>]

On Tue, 19 Jan 2021 16:18:18 -0800
Kir Kolyshkin <kolyshkin@gmail.com> wrote:

> Add a proper reference instead of just using the file name.
> 
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
> ---
>  Documentation/scheduler/sched-bwc.rst      | 3 ++-
>  Documentation/scheduler/sched-rt-group.rst | 2 ++
>  2 files changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/scheduler/sched-bwc.rst b/Documentation/scheduler/sched-bwc.rst
> index a44860d33ffc..dcec7440c222 100644
> --- a/Documentation/scheduler/sched-bwc.rst
> +++ b/Documentation/scheduler/sched-bwc.rst
> @@ -4,7 +4,8 @@ CFS Bandwidth Control
>  
>  .. note::
>     This document only discusses CPU bandwidth control for SCHED_NORMAL.
> -   The SCHED_RT case is covered in Documentation/scheduler/sched-rt-group.rst
> +   The SCHED_RT case is covered in
> +   :ref:`Documentation/scheduler/sched-rt-group.rst <sched-rt-group>`.
>  
>  CFS bandwidth control is a CONFIG_FAIR_GROUP_SCHED extension which allows the
>  specification of the maximum CPU bandwidth available to a group or hierarchy.
> diff --git a/Documentation/scheduler/sched-rt-group.rst b/Documentation/scheduler/sched-rt-group.rst
> index 655a096ec8fb..a3b4aa51c271 100644
> --- a/Documentation/scheduler/sched-rt-group.rst
> +++ b/Documentation/scheduler/sched-rt-group.rst
> @@ -1,3 +1,5 @@
> +.. _sched-rt-group:
> +

So why do you need to do this?  The build system in recent kernels will
generate that reference automatically without the extra markup.

Thanks,

jon