From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id BDA03CA0FF0 for ; Mon, 1 Sep 2025 07:03:20 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 7C13610E38F; Mon, 1 Sep 2025 07:03:12 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=kernel.org header.i=@kernel.org header.b="i7heKHiF"; dkim-atps=neutral Received: from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31]) by gabe.freedesktop.org (Postfix) with ESMTPS id 17C2110E029 for ; Sat, 30 Aug 2025 20:46:45 +0000 (UTC) Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by sea.source.kernel.org (Postfix) with ESMTP id 8645643FD7; Sat, 30 Aug 2025 20:46:44 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id CF130C4CEEB; Sat, 30 Aug 2025 20:46:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1756586804; bh=N1RyWuUPncwemkQz+wtBxmmLRK1pbPwPhqaSXQEgACo=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=i7heKHiF1WEcWegbUMD1XKbmetMnNnCnljRU/sfGxpB5c3sZchsdHRdnTVLky717F dDeCNXpev8o9LRk1S9eXnS8o8kWvMacaFziEO6OdWtswKvTxZQ5pU4eCd2WUx5BQCO 14bLFP5QVji02AMa5CJyqW/en6PTbHSnZ78vGj75ZZT/RVMFCiYHRoYXRol8qlqKgn 3lrkJ1IYbZBkwoMZse44FP62uqEzr0WjQEZOzoSJLrIrlje9NRgPYVERWMHuVkMn2k 2QurVWFt7IIr5AR3ahUSN1uV7FUBrHkmiXJe15aj9LzSrsbpHevBdir8lYlUv2SDdP 83zxdoGwMwcyQ== Date: Sat, 30 Aug 2025 22:46:22 +0200 From: Mauro Carvalho Chehab To: Bagas Sanjaya Cc: Linux Kernel Mailing List , Linux Documentation , Linux DAMON , Linux Memory Management List , Linux Power Management , Linux Block Devices , Linux BPF , Linux Kernel Workflows , Linux KASAN , Linux Devicetree , Linux fsverity , Linux MTD , Linux DRI Development , Linux Kernel Build System , Linux Networking , Linux Sound , Thomas Gleixner , Borislav Petkov , Peter Zijlstra , Josh Poimboeuf , Pawan Gupta , Jonathan Corbet , SeongJae Park , Andrew Morton , David Hildenbrand , Lorenzo Stoakes , "Liam R. Howlett" , Vlastimil Babka , Mike Rapoport , Suren Baghdasaryan , Michal Hocko , Huang Rui , "Gautham R. Shenoy" , Mario Limonciello , Perry Yuan , Jens Axboe , Alexei Starovoitov , Daniel Borkmann , Andrii Nakryiko , Martin KaFai Lau , Eduard Zingerman , Song Liu , Yonghong Song , John Fastabend , KP Singh , Stanislav Fomichev , Hao Luo , Jiri Olsa , Dwaipayan Ray , Lukas Bulwahn , Joe Perches , Andrey Ryabinin , Alexander Potapenko , Andrey Konovalov , Dmitry Vyukov , Vincenzo Frascino , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Eric Biggers , tytso@mit.edu, Richard Weinberger , Zhihao Cheng , David Airlie , Simona Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Nathan Chancellor , Nicolas Schier , Ingo Molnar , Will Deacon , Boqun Feng , Waiman Long , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Simon Horman , Shay Agroskin , Arthur Kiyanovski , David Arinzon , Saeed Bishara , Andrew Lunn , Liam Girdwood , Mark Brown , Jaroslav Kysela , Takashi Iwai , Alexandru Ciobotaru , The AWS Nitro Enclaves Team , Jesper Dangaard Brouer , Laurent Pinchart , Steve French , Meetakshi Setiya , Greg Kroah-Hartman , "Martin K. Petersen" , Bart Van Assche , Thomas =?UTF-8?B?V2Vpw59zY2h1aA==?= , Masahiro Yamada Subject: Re: [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs Message-ID: <20250830224614.6a124f82@foz.lan> In-Reply-To: <20250829075524.45635-13-bagasdotme@gmail.com> References: <20250829075524.45635-1-bagasdotme@gmail.com> <20250829075524.45635-13-bagasdotme@gmail.com> X-Mailer: Claws Mail 4.3.1 (GTK 3.24.49; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Mailman-Approved-At: Mon, 01 Sep 2025 07:02:45 +0000 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Em Fri, 29 Aug 2025 14:55:22 +0700 Bagas Sanjaya 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 > --- > 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