diff mbox

drm/i915/guc: Fix doc reference to intel_guc_fw.c

Message ID 20171128065052.23930-1-j.neuschaefer@gmx.net (mailing list archive)
State New, archived
Headers show

Commit Message

J. Neuschäfer Nov. 28, 2017, 6:50 a.m. UTC
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@intel.com>
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/gpu/i915.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Michal Wajdeczko Nov. 28, 2017, 8:51 a.m. UTC | #1
On Tue, 28 Nov 2017 07:50:52 +0100, Jonathan Neuschäfer  
<j.neuschaefer@gmx.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@intel.com>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.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/
diff mbox

Patch

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