| Message ID | 20230328153614.38027-1-gabbymg94@gmail.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series |
|
| Related | show |
Hi Gabby, Welcome to libcamera, and thank you for contributing. Quoting Gabby George via libcamera-devel (2023-03-28 16:36:14) > I suggest clarifying the IPA acronym as it is not defined in a easily-accessible place and not immediately clear what it refers to. This patch is a practice patch for the google summer of code warmup. The $SUBJECT line is fine, but this commit message could use some extra consideration. When writing a commit message, it should strive to explain the rationale behind the change. Please read: https://cbea.ms/git-commit/ I find it to be a very good description of how I would expect to see commit messages. This message will be embedded into the history of the libcamera project, and so comments such as "This patch is a practice patch for GSOC" isn't really appropriate to go here. Please keep it factual and to the point of the content of the patch. At this point in the patch, we require a 'Signed-off-by:' tag. When you make a commit, please use the '-s' flag to add this with git. > --- Please also notice these three '---' separator markers. Anything after these markers, but before the diff are ignored when applying patches. That gives you a space to add free form comments, which is where a message such as "I'm practicing for GSoC" could be added. > 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 This change itself is fine. I hope we've defined this as a more global glossary somewhere though, but I wouldn't object to merging this (with a correctly formed commit message) Please submit a v2 - Remember to mark the patch as v2 accordingly before submitting, and try to phrase the commit message in a form that would be more appropriate. Look through the commit history of the project for a good idea of the level of content we expect in commit messages. Regards -- Kieran > * > * 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 >
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