[PATCH] Documentation/gpu: Disambiguate SPI term

[PATCH] Documentation/gpu: Disambiguate SPI term

[Bagas Sanjaya]

Documentation/userspace-api/media/glossary.rst:170: WARNING: duplicate term description of SPI, other instance in gpu/amdgpu/amdgpu-glossary

That's because SPI of amdgpu (Shader Processor Input) shares the same
global glossary term as SPI of media subsystem (which is Serial
Peripheral Interface Bus). Disambiguate the former from the latter to
fix the warning.

Note that adding context qualifiers in the term is strictly necessary
in order to make Sphinx happy.

Fixes: dd3d035a7838 ("Documentation/gpu: Add new entries to amdgpu glossary")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250509185845.60bf5e7b@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Also Cc: media maintainers.

 Documentation/gpu/amdgpu/amdgpu-glossary.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gpu/amdgpu/amdgpu-glossary.rst b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
index 2040da593b1490..30812d9d53c645 100644
--- a/Documentation/gpu/amdgpu/amdgpu-glossary.rst
+++ b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
@@ -182,7 +182,7 @@ we have a dedicated glossary for Display Core at
     SMU/SMC
       System Management Unit / System Management Controller
 
-    SPI
+    SPI (AMDGPU)
       Shader Processor Input
 
     SRLC

base-commit: afc6053d4c4b0a6be500b9e643aa17221e93a57b
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation/gpu: Disambiguate SPI term

[Alex Deucher]

On Mon, May 12, 2025 at 3:58 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> Documentation/userspace-api/media/glossary.rst:170: WARNING: duplicate term description of SPI, other instance in gpu/amdgpu/amdgpu-glossary
>
> That's because SPI of amdgpu (Shader Processor Input) shares the same
> global glossary term as SPI of media subsystem (which is Serial
> Peripheral Interface Bus). Disambiguate the former from the latter to
> fix the warning.
>
> Note that adding context qualifiers in the term is strictly necessary
> in order to make Sphinx happy.
>
> Fixes: dd3d035a7838 ("Documentation/gpu: Add new entries to amdgpu glossary")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250509185845.60bf5e7b@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Applied.  Thanks.

Alex

> ---
> Also Cc: media maintainers.
>
>  Documentation/gpu/amdgpu/amdgpu-glossary.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/gpu/amdgpu/amdgpu-glossary.rst b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> index 2040da593b1490..30812d9d53c645 100644
> --- a/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> +++ b/Documentation/gpu/amdgpu/amdgpu-glossary.rst
> @@ -182,7 +182,7 @@ we have a dedicated glossary for Display Core at
>      SMU/SMC
>        System Management Unit / System Management Controller
>
> -    SPI
> +    SPI (AMDGPU)
>        Shader Processor Input
>
>      SRLC
>
> base-commit: afc6053d4c4b0a6be500b9e643aa17221e93a57b
> --
> An old man doll... just what I always wanted! - Clara
>