2017-12-12 11:40:37

by Markus Heiser

[permalink] [raw]
Subject: [PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.c

With commit d9e2e0143c the 'GuC-specific firmware loader' doc
section was removed from intel_guc_loader.c without a
replacement. So lets remove it from the Kernel-doc::

.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
:doc: GuC-specific firmware loader

With commit e8668bbcb0 intel_guc_loader.c was renamed to to
intel_guc_fw.c and to name just one, intel_guc_init_hw() was
renamed to intel_guc_fw_upload(). Since we get errors in the
Sphinx build like:

- Error: Cannot open file ./drivers/gpu/drm/i915/intel_guc_loader.c

Change the kernel-doc directive from intel_guc_loader.c to
intel_guc_fw.c

Signed-off-by: Markus Heiser <[email protected]>
---
Documentation/gpu/i915.rst | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 2e7ee03..e94d3ac 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
--
2.7.4


2017-12-12 12:05:09

by Michal Wajdeczko

[permalink] [raw]
Subject: Re: [PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.c

On Tue, 12 Dec 2017 12:38:37 +0100, Markus Heiser
<[email protected]> wrote:

> With commit d9e2e0143c the 'GuC-specific firmware loader' doc
> section was removed from intel_guc_loader.c without a
> replacement. So lets remove it from the Kernel-doc::
>
> .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
> :doc: GuC-specific firmware loader
>
> With commit e8668bbcb0 intel_guc_loader.c was renamed to to
> intel_guc_fw.c and to name just one, intel_guc_init_hw() was
> renamed to intel_guc_fw_upload(). Since we get errors in the
> Sphinx build like:
>
> - Error: Cannot open file ./drivers/gpu/drm/i915/intel_guc_loader.c
>
> Change the kernel-doc directive from intel_guc_loader.c to
> intel_guc_fw.c
>
> Signed-off-by: Markus Heiser <[email protected]>
> ---

Thanks for your patch, but similar fix is already merged here [1]

Michal

[1]
https://cgit.freedesktop.org/drm-tip/commit/?id=006c23327f8de8575508c458131b304188d426f7

2017-12-12 12:12:31

by Markus Heiser

[permalink] [raw]
Subject: Re: [PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.c


> Am 12.12.2017 um 13:05 schrieb Michal Wajdeczko <[email protected]>:
>
> On Tue, 12 Dec 2017 12:38:37 +0100, Markus Heiser <[email protected]> wrote:
>
>> With commit d9e2e0143c the 'GuC-specific firmware loader' doc
>> section was removed from intel_guc_loader.c without a
>> replacement. So lets remove it from the Kernel-doc::
>>
>> .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
>> :doc: GuC-specific firmware loader
>>
>> With commit e8668bbcb0 intel_guc_loader.c was renamed to to
>> intel_guc_fw.c and to name just one, intel_guc_init_hw() was
>> renamed to intel_guc_fw_upload(). Since we get errors in the
>> Sphinx build like:
>>
>> - Error: Cannot open file ./drivers/gpu/drm/i915/intel_guc_loader.c
>>
>> Change the kernel-doc directive from intel_guc_loader.c to
>> intel_guc_fw.c
>>
>> Signed-off-by: Markus Heiser <[email protected]>
>> ---
>
> Thanks for your patch, but similar fix is already merged here [1]
>
> Michal
>
> [1] https://cgit.freedesktop.org/drm-tip/commit/?id=006c23327f8de8575508c458131b304188d426f7


Thanks for pointing out. I miss the ":doc: GuC-specific firmware loader"
fix in that patch (doc section was removed in d9e2e0143c). Can you or
someone else from @intel fix this also?

Thanks!

-- Markus --



> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html

2017-12-12 15:24:06

by Daniel Vetter

[permalink] [raw]
Subject: Re: [PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.c

On Tue, Dec 12, 2017 at 01:11:43PM +0100, Markus Heiser wrote:
>
> > Am 12.12.2017 um 13:05 schrieb Michal Wajdeczko <[email protected]>:
> >
> > On Tue, 12 Dec 2017 12:38:37 +0100, Markus Heiser <[email protected]> wrote:
> >
> >> With commit d9e2e0143c the 'GuC-specific firmware loader' doc
> >> section was removed from intel_guc_loader.c without a
> >> replacement. So lets remove it from the Kernel-doc::
> >>
> >> .. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
> >> :doc: GuC-specific firmware loader
> >>
> >> With commit e8668bbcb0 intel_guc_loader.c was renamed to to
> >> intel_guc_fw.c and to name just one, intel_guc_init_hw() was
> >> renamed to intel_guc_fw_upload(). Since we get errors in the
> >> Sphinx build like:
> >>
> >> - Error: Cannot open file ./drivers/gpu/drm/i915/intel_guc_loader.c
> >>
> >> Change the kernel-doc directive from intel_guc_loader.c to
> >> intel_guc_fw.c
> >>
> >> Signed-off-by: Markus Heiser <[email protected]>
> >> ---
> >
> > Thanks for your patch, but similar fix is already merged here [1]
> >
> > Michal
> >
> > [1] https://cgit.freedesktop.org/drm-tip/commit/?id=006c23327f8de8575508c458131b304188d426f7
>
>
> Thanks for pointing out. I miss the ":doc: GuC-specific firmware loader"
> fix in that patch (doc section was removed in d9e2e0143c). Can you or
> someone else from @intel fix this also?

I've rebased the patch from you to only take that remaining part.

Thanks for fixing this.
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

2017-12-12 15:44:14

by Markus Heiser

[permalink] [raw]
Subject: Re: [PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.c


> Am 12.12.2017 um 16:23 schrieb Daniel Vetter <[email protected]>:
>
>>> Thanks for your patch, but similar fix is already merged here [1]
>>>
>>> Michal
>>>
>>> [1] https://cgit.freedesktop.org/drm-tip/commit/?id=006c23327f8de8575508c458131b304188d426f7
>>
>>
>> Thanks for pointing out. I miss the ":doc: GuC-specific firmware loader"
>> fix in that patch (doc section was removed in d9e2e0143c). Can you or
>> someone else from @intel fix this also?
>
> I've rebased the patch from you to only take that remaining part.
>
> Thanks for fixing this.
> -Daniel

Thanks for picking this up [1].

[1] https://cgit.freedesktop.org/drm/drm-intel/commit/?id=0132a1a5

-- Markus --