diff mbox series

[1/2] drm/doc: fix duplicate declaration warning

Message ID 20230621123156.14907-1-jani.nikula@intel.com (mailing list archive)
State New, archived
Headers show
Series [1/2] drm/doc: fix duplicate declaration warning | expand

Commit Message

Jani Nikula June 21, 2023, 12:31 p.m. UTC
We have duplicate kernel-doc directives for the same struct, leading to:

/home/jani/src/linux/Documentation/gpu/driver-uapi.rst:2279: WARNING: Duplicate C declaration, also defined at rfc/i915_scheduler:3.
Declaration is '.. c:struct:: i915_context_engines_parallel_submit'.

Use the Sphinx C domain namespace for the rfc document to fix this.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Documentation/gpu/rfc/i915_scheduler.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Luca Coelho June 26, 2023, 12:05 p.m. UTC | #1
On Wed, 2023-06-21 at 15:31 +0300, Jani Nikula wrote:
> We have duplicate kernel-doc directives for the same struct, leading to:
> 
> /home/jani/src/linux/Documentation/gpu/driver-uapi.rst:2279: WARNING: Duplicate C declaration, also defined at rfc/i915_scheduler:3.
> Declaration is '.. c:struct:: i915_context_engines_parallel_submit'.
> 
> Use the Sphinx C domain namespace for the rfc document to fix this.
> 
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---

This looks pretty straightforward.

Reviewed-by: Luca Coelho <luciano.coelho@intel.com>


--
Cheers,
Luca.
Jani Nikula June 26, 2023, 5:18 p.m. UTC | #2
On Mon, 26 Jun 2023, Luca Coelho <luca@coelho.fi> wrote:
> On Wed, 2023-06-21 at 15:31 +0300, Jani Nikula wrote:
>> We have duplicate kernel-doc directives for the same struct, leading to:
>> 
>> /home/jani/src/linux/Documentation/gpu/driver-uapi.rst:2279: WARNING: Duplicate C declaration, also defined at rfc/i915_scheduler:3.
>> Declaration is '.. c:struct:: i915_context_engines_parallel_submit'.
>> 
>> Use the Sphinx C domain namespace for the rfc document to fix this.
>> 
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>
> This looks pretty straightforward.
>
> Reviewed-by: Luca Coelho <luciano.coelho@intel.com>

Thanks, pushed both.

BR,
Jani.


>
>
> --
> Cheers,
> Luca.
diff mbox series

Patch

diff --git a/Documentation/gpu/rfc/i915_scheduler.rst b/Documentation/gpu/rfc/i915_scheduler.rst
index d630f15ab795..ec086e7a43ff 100644
--- a/Documentation/gpu/rfc/i915_scheduler.rst
+++ b/Documentation/gpu/rfc/i915_scheduler.rst
@@ -135,9 +135,13 @@  Add I915_CONTEXT_ENGINES_EXT_PARALLEL_SUBMIT and
 drm_i915_context_engines_parallel_submit to the uAPI to implement this
 extension.
 
+.. c:namespace-push:: rfc
+
 .. kernel-doc:: include/uapi/drm/i915_drm.h
         :functions: i915_context_engines_parallel_submit
 
+.. c:namespace-pop::
+
 Extend execbuf2 IOCTL to support submitting N BBs in a single IOCTL
 -------------------------------------------------------------------
 Contexts that have been configured with the 'set_parallel' extension can only