On Tue, 2020-04-14 at 20:42 +0200, Lars Engebretsen wrote:
A description of the change is required to describe the change.
I think I mentioned this in my email, but I was lazy to provide an example.
Description of changes are required even for the smallest of changes; I think
it's mostly so that people always keep their brains trained to describe all
changes.
So here, you could say something like:
---------------------------------------------------------------------------
This change removes the semi-colon from the devm_iio_device_register() macro
which seems to have been added by accident via commit 63b19547cc3d9 ("iio: Use
macro magic to avoid manual assign of driver_module").
---------------------------------------------------------------------------
Make sure commit comments stay within a 75 column width limit.
And make sure you add a version tag for the next patch/re-send.
i.e. do git format-patch -v2 [or v3 for 3rd version,]
And it's a good idea to add a changelog after the line with '---' in the patch
file. Text after that line gets ignored for the commit description.
Something like:
Changelog v1 -> v2:
* added commit change description
> Signed-off-by: Lars Engebretsen <lars@xxxxxxxxxxxxxx>
> ---
> include/linux/iio/iio.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index d63884a54939..76ba7c9fd3e0 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -597,7 +597,7 @@ void iio_device_unregister(struct iio_dev *indio_dev);
> * 0 on success, negative error number on failure.
> */
> #define devm_iio_device_register(dev, indio_dev) \
> - __devm_iio_device_register((dev), (indio_dev), THIS_MODULE);
> + __devm_iio_device_register((dev), (indio_dev), THIS_MODULE)
> int __devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev,
> struct module *this_mod);
> int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
