From patchwork Tue Nov 28 12:58:33 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?J=2E_Neusch=C3=A4fer?= X-Patchwork-Id: 10080411 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 606CE6056A for ; Tue, 28 Nov 2017 14:15:52 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 4F677292A6 for ; Tue, 28 Nov 2017 14:15:52 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4431F292A8; Tue, 28 Nov 2017 14:15:52 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id C1B08292A6 for ; Tue, 28 Nov 2017 14:15:51 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id F12CE6E62E; Tue, 28 Nov 2017 14:15:46 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mout.gmx.net (mout.gmx.net [212.227.17.20]) by gabe.freedesktop.org (Postfix) with ESMTPS id E6A5A6E406; Tue, 28 Nov 2017 12:59:02 +0000 (UTC) Received: from latitude ([88.153.7.124]) by mail.gmx.com (mrgmx103 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Lkfii-1ertlD3AIO-00aVFq; Tue, 28 Nov 2017 13:58:47 +0100 Date: Tue, 28 Nov 2017 13:58:33 +0100 From: Jonathan =?utf-8?Q?Neusch=C3=A4fer?= To: Michal Wajdeczko Subject: Re: [PATCH] drm/i915/guc: Fix doc reference to intel_guc_fw.c Message-ID: <20171128125833.cuosx4e44r5diset@latitude> References: <20171128065052.23930-1-j.neuschaefer@gmx.net> MIME-Version: 1.0 In-Reply-To: User-Agent: NeoMutt/20170609 (1.8.3) X-Provags-ID: V03:K0:QU4HaGYRdvXPobwKiLuF6MhgpFiqOHGM5+q0FGJvgGaAgKX/2CB YZDmOhfareAxUSb58/1fkm7wCVFR80OYvWJ+DUb94rwZ/ieAKJsfgWkIg/XmdQub7OnxWME rtgKhb9I0QexfVU70hlA4Qxk27KauFjpxpjKmAZRXEHTLNJh0qYekynz0usB6hL6MrfDpu7 6wWFEsPYxaMGbCd1SQJNA== X-UI-Out-Filterresults: notjunk:1; V01:K0:lMp4tsi1GoM=:Hx0ndbGARcflcQdI/p4jQ9 R/Xwnz/GvylQnOk85nhNJkiVNvaAr6xLKEDzbcNlu9dTPeo0/5kxvu1a2p/A6WLS9PsW32aiy 4esNsKCKjR2HFaLeQFCgNcC2VcRH9XD6Ib+CBLcnfnKlhWJK/8qQfKMyAmzCjWAu+2SFnGJdk SLuvTavkcc+wiPazLPbKdTa3b+dxLs32AxcLT6lVVvnA1k0SeH+O3Mqc1W4nnok/zZVvKjpRY qckZDUVHhALfSA/VXwhUSBb8lrhGSV85JcmYue07vt031csE2mJ3rvSAesr2UvCRDOK/o7APr Dr8DkQ5HMhKAxX12eQRSSH0bYDdNngJiGMhwuppGT1ub1jEZfow4iZh+Il8UE2LXVI/bodsY8 NMLCnN+VAamly1tXI6ObJUaIYET1Fi6G2kBmKKtwAjVcw1hoxhXLRMF40tAhdFKOq6YbCDI9C i//TQV9i0kpY+j8FyhPwrR5UehS5P9l1+RPlgu7MyCeJFMh9zWVrxRH9zF/wo0Wl03asfBs46 azlD8SceChGtvDwbsLOyfzOYvXxoVXNO0DxZOJ+Pa2y5jNmUpXpXpRMy3Wv6+zindQp3VmNOU vmV6DbxIP5cPxQsBeCCpoGMbnvHNfaCrqX7OOBCOTp+/KJjLo8qwhI4F+fs7g9OFoieIbGzoi UY6vToIVcn8Q+jl1gDHHXo6pTF1Af7SL91IO5PorX0jczkKZrjtJVoDzIXdsS0oEum45vV2xh IFo3i2qyOoLmhWIr0l4QhPzMPtl367LKW1Z5WYMECi9bFWrRq4zeSl3PcGvjXlTXNt812w6xS D/2iAGG3fdPj7CsgVltnm18CbGRwtHTH3MNQVlHV+i1kO9dyqI= X-Mailman-Approved-At: Tue, 28 Nov 2017 14:15:45 +0000 Cc: Jonathan Corbet , linux-doc@vger.kernel.org, David Airlie , intel-gfx@lists.freedesktop.org, Joonas Lahtinen , Jonathan =?utf-8?Q?Neusch=C3=A4fer?= , linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Rodrigo Vivi , Daniel Vetter X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.18 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" X-Virus-Scanned: ClamAV using ClamSMTP On Tue, Nov 28, 2017 at 09:51:13AM +0100, Michal Wajdeczko wrote: > On Tue, 28 Nov 2017 07:50:52 +0100, Jonathan Neuschäfer > wrote: > > > Sphinx complains that it can't find intel_guc_loader.c, and rightly so: > > The file has been renamed. > > > > Fixes: e8668bbcb0f9 ("drm/i915/guc: Rename intel_guc_loader.c to > > intel_guc_fw.c") > > Cc: Michal Wajdeczko > > Signed-off-by: Jonathan Neuschäfer > > --- > > Documentation/gpu/i915.rst | 4 ++-- > > 1 file changed, 2 insertions(+), 2 deletions(-) > > > > diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst > > index 2e7ee0313c1c..e21698e16534 100644 > > --- a/Documentation/gpu/i915.rst > > +++ b/Documentation/gpu/i915.rst > > @@ -341,10 +341,10 @@ GuC > > GuC-specific firmware loader > > ---------------------------- > > -.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c > > :doc: GuC-specific firmware loader > > -.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c > > +.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c > > :internal: > > GuC-based command submission > > + Ville > > Well, this will fix sphinx error, but in my opinion it will not make > i915 documentation any better. See my earlier patch/comments in [1]. Thanks for the pointer. Hmm, right, given that there's no "DOC:" line in intel_guc_fw.c anymore, the ":doc:" directive above is not useful. As a tiny step towards more complete documentation (and to keep people from patching this spot again ;), IMHO it makes sense to do this (it's of course up to the maintainers whether they agree): ----------------------------------------------------------------------- ----------------------------------------------------------------------- > So maybe better to wait for other comments which way to go. Makes sense. Thanks, Jonathan Neuschäfer > > Thanks for the patch, > Michal > > [1] https://patchwork.freedesktop.org/patch/188424/ diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst index 2e7ee0313c1c..e94d3ac2bdd0 100644 --- a/Documentation/gpu/i915.rst +++ b/Documentation/gpu/i915.rst @@ -341,10 +341,7 @@ GuC GuC-specific firmware loader ---------------------------- -.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c - :doc: GuC-specific firmware loader - -.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c +.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_fw.c :internal: GuC-based command submission