linux-kernel - Re: [PATCH] drm/i915/guc: Fix doc reference to intel_guc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 28 Nov 2017 09:51:13 +0100
From:   "Michal Wajdeczko" <michal.wajdeczko@...el.com>
To:     linux-doc@...r.kernel.org,
        Jonathan Neuschäfer <j.neuschaefer@....net>
Cc:     "Jani Nikula" <jani.nikula@...ux.intel.com>,
        "Joonas Lahtinen" <joonas.lahtinen@...ux.intel.com>,
        "Rodrigo Vivi" <rodrigo.vivi@...el.com>,
        "Daniel Vetter" <daniel.vetter@...el.com>,
        "Sean Paul" <seanpaul@...omium.org>,
        "David Airlie" <airlied@...ux.ie>,
        "Jonathan Corbet" <corbet@....net>,
        intel-gfx@...ts.freedesktop.org, dri-devel@...ts.freedesktop.org,
        linux-kernel@...r.kernel.org,
        Ville Syrjälä <ville.syrjala@...ux.intel.com>
Subject: Re: [PATCH] drm/i915/guc: Fix doc reference to intel_guc_fw.c

On Tue, 28 Nov 2017 07:50:52 +0100, Jonathan Neuschäfer  
<j.neuschaefer@....net> 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 <michal.wajdeczko@...el.com>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@....net>
> ---
>  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].
So maybe better to wait for other comments which way to go.

Thanks for the patch,
Michal

[1] https://patchwork.freedesktop.org/patch/188424/