Message-ID: <20250830224614.6a124f82@foz.lan>
Date: Sat, 30 Aug 2025 22:46:22 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>, Linux
 Documentation <linux-doc@...r.kernel.org>, Linux DAMON
 <damon@...ts.linux.dev>, Linux Memory Management List <linux-mm@...ck.org>,
 Linux Power Management <linux-pm@...r.kernel.org>, Linux Block Devices
 <linux-block@...r.kernel.org>, Linux BPF <bpf@...r.kernel.org>, Linux
 Kernel Workflows <workflows@...r.kernel.org>, Linux KASAN
 <kasan-dev@...glegroups.com>, Linux Devicetree
 <devicetree@...r.kernel.org>, Linux fsverity <fsverity@...ts.linux.dev>,
 Linux MTD <linux-mtd@...ts.infradead.org>, Linux DRI Development
 <dri-devel@...ts.freedesktop.org>, Linux Kernel Build System
 <linux-lbuild@...r.kernel.org>, Linux Networking <netdev@...r.kernel.org>,
 Linux Sound <linux-sound@...r.kernel.org>, Thomas Gleixner
 <tglx@...utronix.de>, Borislav Petkov <bp@...en8.de>, Peter Zijlstra
 <peterz@...radead.org>, Josh Poimboeuf <jpoimboe@...nel.org>, Pawan Gupta
 <pawan.kumar.gupta@...ux.intel.com>, Jonathan Corbet <corbet@....net>,
 SeongJae Park <sj@...nel.org>, Andrew Morton <akpm@...ux-foundation.org>,
 David Hildenbrand <david@...hat.com>, Lorenzo Stoakes
 <lorenzo.stoakes@...cle.com>, "Liam R. Howlett" <Liam.Howlett@...cle.com>,
 Vlastimil Babka <vbabka@...e.cz>, Mike Rapoport <rppt@...nel.org>, Suren
 Baghdasaryan <surenb@...gle.com>, Michal Hocko <mhocko@...e.com>, Huang Rui
 <ray.huang@....com>, "Gautham R. Shenoy" <gautham.shenoy@....com>, Mario
 Limonciello <mario.limonciello@....com>, Perry Yuan <perry.yuan@....com>,
 Jens Axboe <axboe@...nel.dk>, Alexei Starovoitov <ast@...nel.org>, Daniel
 Borkmann <daniel@...earbox.net>, Andrii Nakryiko <andrii@...nel.org>,
 Martin KaFai Lau <martin.lau@...ux.dev>, Eduard Zingerman
 <eddyz87@...il.com>, Song Liu <song@...nel.org>, Yonghong Song
 <yonghong.song@...ux.dev>, John Fastabend <john.fastabend@...il.com>, KP
 Singh <kpsingh@...nel.org>, Stanislav Fomichev <sdf@...ichev.me>, Hao Luo
 <haoluo@...gle.com>, Jiri Olsa <jolsa@...nel.org>, Dwaipayan Ray
 <dwaipayanray1@...il.com>, Lukas Bulwahn <lukas.bulwahn@...il.com>, Joe
 Perches <joe@...ches.com>, Andrey Ryabinin <ryabinin.a.a@...il.com>,
 Alexander Potapenko <glider@...gle.com>, Andrey Konovalov
 <andreyknvl@...il.com>, Dmitry Vyukov <dvyukov@...gle.com>, Vincenzo
 Frascino <vincenzo.frascino@....com>, Rob Herring <robh@...nel.org>,
 Krzysztof Kozlowski <krzk+dt@...nel.org>, Conor Dooley
 <conor+dt@...nel.org>, Eric Biggers <ebiggers@...nel.org>, tytso@....edu,
 Richard Weinberger <richard@....at>, Zhihao Cheng
 <chengzhihao1@...wei.com>, David Airlie <airlied@...il.com>, Simona Vetter
 <simona@...ll.ch>, Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
 Maxime Ripard <mripard@...nel.org>, Thomas Zimmermann
 <tzimmermann@...e.de>, Nathan Chancellor <nathan@...nel.org>, Nicolas
 Schier <nicolas.schier@...ux.dev>, Ingo Molnar <mingo@...hat.com>, Will
 Deacon <will@...nel.org>, Boqun Feng <boqun.feng@...il.com>, Waiman Long
 <longman@...hat.com>, "David S. Miller" <davem@...emloft.net>, Eric Dumazet
 <edumazet@...gle.com>, Jakub Kicinski <kuba@...nel.org>, Paolo Abeni
 <pabeni@...hat.com>, Simon Horman <horms@...nel.org>, Shay Agroskin
 <shayagr@...zon.com>, Arthur Kiyanovski <akiyano@...zon.com>, David Arinzon
 <darinzon@...zon.com>, Saeed Bishara <saeedb@...zon.com>, Andrew Lunn
 <andrew@...n.ch>, Liam Girdwood <lgirdwood@...il.com>, Mark Brown
 <broonie@...nel.org>, Jaroslav Kysela <perex@...ex.cz>, Takashi Iwai
 <tiwai@...e.com>, Alexandru Ciobotaru <alcioa@...zon.com>, The AWS Nitro
 Enclaves Team <aws-nitro-enclaves-devel@...zon.com>, Jesper Dangaard Brouer
 <hawk@...nel.org>, Laurent Pinchart <laurent.pinchart@...asonboard.com>,
 Steve French <stfrench@...rosoft.com>, Meetakshi Setiya
 <msetiya@...rosoft.com>, Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 "Martin K. Petersen" <martin.petersen@...cle.com>, Bart Van Assche
 <bvanassche@....org>, Thomas Weißschuh
 <linux@...ssschuh.net>, Masahiro Yamada <masahiroy@...nel.org>
Subject: Re: [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA
 Driver docs

Em Fri, 29 Aug 2025 14:55:22 +0700
Bagas Sanjaya <bagasdotme@...il.com> escreveu:

> ASoC codec and platform driver docs contain reference to writing ALSA
> driver docs, as an external link. Use :doc: directive for the job
> instead.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/sound/soc/codec.rst    | 4 ++--
>  Documentation/sound/soc/platform.rst | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/sound/soc/codec.rst b/Documentation/sound/soc/codec.rst
> index af973c4cac9309..b9d87a4f929b5d 100644
> --- a/Documentation/sound/soc/codec.rst
> +++ b/Documentation/sound/soc/codec.rst
> @@ -131,8 +131,8 @@ The codec driver also supports the following ALSA PCM operations:-
>  	int (*prepare)(struct snd_pcm_substream *);
>    };
>  
> -Please refer to the ALSA driver PCM documentation for details.
> -https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
> +Please refer to the :doc:`ALSA driver PCM documentation
> +<../kernel-api/writing-an-alsa-driver>` for details.
>  
>  
>  DAPM description
> diff --git a/Documentation/sound/soc/platform.rst b/Documentation/sound/soc/platform.rst
> index 7036630eaf016c..bd21d0a4dd9b0b 100644
> --- a/Documentation/sound/soc/platform.rst
> +++ b/Documentation/sound/soc/platform.rst
> @@ -45,8 +45,8 @@ snd_soc_component_driver:-
>  	...
>    };
>  
> -Please refer to the ALSA driver documentation for details of audio DMA.
> -https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
> +Please refer to the :doc:`ALSA driver documentation
> +<../kernel-api/writing-an-alsa-driver>` for details of audio DMA.

Don't use relative paths for :doc:. They don't work well, specially
when one uses SPHINXDIRS.

The best is o use Documentation/kernel-api/writing-an-alsa-driver.rst
and let automarkup figure it out. As we have a checker, broken
references generate warnings at build time.

Regards,
Mauro

Powered by blists - more mailing lists