[libcamera-devel] [PATCH v2] doc: ipa: Clarify IPA acronym in its namespace description

[Laurent Pinchart]

On Thu, Mar 30, 2023 at 11:48:27AM +0100, Kieran Bingham via libcamera-devel wrote:
> Quoting Gabby George via libcamera-devel (2023-03-29 04:13:45)
> > Clarifies IPA's acronym by specifying what "IPA" stands for as part of the ipa namespaces' "brief" doxygen-generated description.  This allows visitors to the docs to immediately have an idea of the purpose of the IPA namespace at a glance.  Because of the prevalence and importance of the IPA namespace and functionality, the fact that it stands for "Image Processing Algorithm" should be accessible to even casual perusers of the docs.
> > 
> 
> That's a much more reasonable message, thanks.
> 
> Point 6 at https://cbea.ms/git-commit/#wrap-72 highlights that commits
> should usually be wrapped at 72 characters. Your commit is all written
> as a single line presently. It can be wrapped when applying so it's not
> a blocker, but please consider this for future patches.
> 
> Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

No need to resend for this indeed, I'll wrap the commit message when
applying the patch.

Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

> > Signed-off-by: Gabby George <gabbymg94 at gmail.com>
> > ---
> >  src/ipa/libipa/module.cpp | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/src/ipa/libipa/module.cpp b/src/ipa/libipa/module.cpp
> > index 77352104..ee01f12a 100644
> > --- a/src/ipa/libipa/module.cpp
> > +++ b/src/ipa/libipa/module.cpp
> > @@ -17,7 +17,7 @@ namespace libcamera {
> >  LOG_DEFINE_CATEGORY(IPAModuleAlgo)
> >  
> >  /**
> > - * \brief The IPA namespace
> > + * \brief The IPA (Image Processing Algorithm) namespace
> >   *
> >   * The IPA namespace groups all types specific to IPA modules. It serves as the
> >   * top-level namespace for the IPA library libipa, and also contains
> > -- 
> > 2.34.1
> >

-- 
Regards,

Laurent Pinchart