Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Tue, 28 Nov 2017 13:58:33 +0100
From:   Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>
To:     Michal Wajdeczko <michal.wajdeczko@intel.com>
Cc:     linux-doc@vger.kernel.org,
        Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>,
        Jani Nikula <jani.nikula@linux.intel.com>,
        Joonas Lahtinen <joonas.lahtinen@linux.intel.com>,
        Rodrigo Vivi <rodrigo.vivi@intel.com>,
        Daniel Vetter <daniel.vetter@intel.com>,
        Sean Paul <seanpaul@chromium.org>,
        David Airlie <airlied@linux.ie>,
        Jonathan Corbet <corbet@lwn.net>,
        intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org,
        linux-kernel@vger.kernel.org,
        Ville =?utf-8?B?U3lyasOkbMOk?= <ville.syrjala@linux.intel.com>
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>
 <op.zaen7nglxaggs7@mwajdecz-mobl1.ger.corp.intel.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
        protocol="application/pgp-signature"; boundary="7uteszgpkudeluao"
Content-Disposition: inline
In-Reply-To: <op.zaen7nglxaggs7@mwajdecz-mobl1.ger.corp.intel.com>
User-Agent: NeoMutt/20170609 (1.8.3)
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


--7uteszgpkudeluao
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Nov 28, 2017 at 09:51:13AM +0100, Michal Wajdeczko wrote:
> On Tue, 28 Nov 2017 07:50:52 +0100, Jonathan Neusch=C3=A4fer
> <j.neuschaefer@gmx.net> wrote:
>=20
> > Sphinx complains that it can't find intel_guc_loader.c, and rightly so:
> > The file has been renamed.
> >=20
> > Fixes: e8668bbcb0f9 ("drm/i915/guc: Rename intel_guc_loader.c to
> > intel_guc_fw.c")
> > Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
> > Signed-off-by: Jonathan Neusch=C3=A4fer <j.neuschaefer@gmx.net>
> > ---
> >  Documentation/gpu/i915.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >=20
> > 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
>=20
> + Ville
>=20
> 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
=66rom patching this spot again ;), IMHO it makes sense to do this (it's
of course up to the maintainers whether they agree):

-----------------------------------------------------------------------
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
 ----------------------------
=20
-.. 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:
=20
 GuC-based command submission
-----------------------------------------------------------------------

> So maybe better to wait for other comments which way to go.

Makes sense.


Thanks,
Jonathan Neusch=C3=A4fer

>=20
> Thanks for the patch,
> Michal
>=20
> [1] https://patchwork.freedesktop.org/patch/188424/

--7uteszgpkudeluao
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQIcBAABAgAGBQJaHV1wAAoJEAgwRJqO81/b2OgP/06L6hL0jqdPGiaRD++Lohxs
fQfxwcVUa2yYsgFXvo7N/uMzxP9ueJYck/Y338sb4tifcFzyvgEkb99M2O84mzBc
oas8am2JS69HWk438+EERgoVl5VGIVhDzKKhRCitS2J2Ugg+Y5nQiQZP0zewRJNC
BAJvNZBd9Jp+SB8whCaHfw+HXkaxG84ktsy8z9K2SAL3T2SEI9Gnbp3QPG+8Lkm+
TO92R51MuOeq2t2PjYj7GlSQJxAFMki7/ZmufT0cYa+MdmGw/Bv6ni1XLS0qj5Am
nd9HB3012Gcjb6gpKix5DWMpOrPTd3bAOhFT4fGYszKhZIKohuTvsPzp81TU1Cc1
nDdwww1oydF+SpaZMfFQOqwWWu4jq1B62qDh2Z7B25i69WGcL6sBKpBN7MpyytrD
JwUdiFvPTJfc5Mom7+vcdzvCzaGL6VYjx1WLYZwcFl1ZQe/QNPEk4tsKPq0xMsas
7vNktSm/ml6R92o/Sz/fKId4wolb99QVa9rOWc43BLTrv6qCVvRLFJp3gvrVeSCT
19tbWzc4NC3YYJJ6hYgObxU4Jehxzw9f7ND7j3AXcS+XncoFPG6OXKstNjDykHvd
gYqeGHSwVCHkN6aDif0wuEGFmk12+yFUcuATb0Pw5pMKDFPOPBqVYk49aeXReUMk
xg8cD7k7pyKbI6c4ZADg
=LEUZ
-----END PGP SIGNATURE-----

--7uteszgpkudeluao--

From 1585299208259802153@xxx Tue Nov 28 08:52:18 +0000 2017
X-GM-THRID: 1585291755797685417
X-Gmail-Labels: Inbox,Category Forums,HistoricalUnread