[libcamera-devel] Documentation: Fix too short title underline in ipa.rst
diff mbox series

Message ID 20210513045323.3593490-1-hiroh@chromium.org
State Accepted
Headers show
Series
  • [libcamera-devel] Documentation: Fix too short title underline in ipa.rst
Related show

Commit Message

Hirokazu Honda May 13, 2021, 4:53 a.m. UTC
Sphinx build is broken from the commit (0906ddb2) because a
title underline is too short. This fixed the breakage.

Signed-off-by: Hirokazu Honda <hiroh@chromium.org>
---
 Documentation/guides/ipa.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Umang Jain May 13, 2021, 7:20 a.m. UTC | #1
Hi Hiro

Thanks for your patch. I too, noticed this breakage just a few moments ago.

On 5/13/21 10:23 AM, Hirokazu Honda wrote:
> Sphinx build is broken from the commit (0906ddb2) because a
> title underline is too short. This fixed the breakage.
generally we use append a Fixes tag in these cases.
        Fixes: 0906ddb2681a ("Documentation: Add IPA writers guide")

However, it can be applied while committing.
>
> Signed-off-by: Hirokazu Honda <hiroh@chromium.org>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>   Documentation/guides/ipa.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst
> index e53486d1..cbffbd9a 100644
> --- a/Documentation/guides/ipa.rst
> +++ b/Documentation/guides/ipa.rst
> @@ -437,7 +437,7 @@ direct return, since it is an int32, while the other output parameter is a
>   pointer-based output parameter.
>   
>   Using the IPA interface (IPA Module)
> ------------------------------
> +------------------------------------
>   
>   The following header is necessary to implement an IPA Module (with raspberrypi
>   as an example):
Paul Elder May 13, 2021, 8:23 a.m. UTC | #2
Hi Hiro,

Thank you for the patch.

On Thu, May 13, 2021 at 01:53:23PM +0900, Hirokazu Honda wrote:
> Sphinx build is broken from the commit (0906ddb2) because a
> title underline is too short. This fixed the breakage.
> 
> Signed-off-by: Hirokazu Honda <hiroh@chromium.org>

Oh, you beat me to it :)

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

I'll add a Fixes tag when applying.


> ---
>  Documentation/guides/ipa.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst
> index e53486d1..cbffbd9a 100644
> --- a/Documentation/guides/ipa.rst
> +++ b/Documentation/guides/ipa.rst
> @@ -437,7 +437,7 @@ direct return, since it is an int32, while the other output parameter is a
>  pointer-based output parameter.
>  
>  Using the IPA interface (IPA Module)
> ------------------------------
> +------------------------------------
>  
>  The following header is necessary to implement an IPA Module (with raspberrypi
>  as an example):
> -- 
> 2.31.1.607.g51e8a6a459-goog
>

Patch
diff mbox series

diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst
index e53486d1..cbffbd9a 100644
--- a/Documentation/guides/ipa.rst
+++ b/Documentation/guides/ipa.rst
@@ -437,7 +437,7 @@  direct return, since it is an int32, while the other output parameter is a
 pointer-based output parameter.
 
 Using the IPA interface (IPA Module)
------------------------------
+------------------------------------
 
 The following header is necessary to implement an IPA Module (with raspberrypi
 as an example):