In the comments there where some grammar mistakes and references to
struct names that have gotten renamed over time but not updated
in the comments.
Signed-off-by: Paulo Miguel Almeida <[email protected]>
---
drivers/staging/pi433/pi433_if.h | 23 +++++++++++------------
1 file changed, 11 insertions(+), 12 deletions(-)
diff --git a/drivers/staging/pi433/pi433_if.h b/drivers/staging/pi433/pi433_if.h
index d5c1521192c1..855f0bebdc1c 100644
--- a/drivers/staging/pi433/pi433_if.h
+++ b/drivers/staging/pi433/pi433_if.h
@@ -5,14 +5,13 @@
* userspace interface for pi433 radio module
*
* Pi433 is a 433MHz radio module for the Raspberry Pi.
- * It is based on the HopeRf Module RFM69CW. Therefore inside of this
- * driver, you'll find an abstraction of the rf69 chip.
+ * It is based on the HopeRf Module RFM69CW. Therefore, inside of this
+ * driver you'll find an abstraction of the rf69 chip.
*
- * If needed, this driver could be extended, to also support other
- * devices, basing on HopeRfs rf69.
+ * If needed this driver could also be extended to support other
+ * devices based on HopeRf rf69 as well as HopeRf modules with a similar
+ * interface such as RFM69HCW, RFM12, RFM95 and so on.
*
- * The driver can also be extended, to support other modules of
- * HopeRf with a similar interace - e. g. RFM69HCW, RFM12, RFM95, ...
* Copyright (C) 2016 Wolf-Entwicklungen
* Marcus Wolf <[email protected]>
*/
@@ -33,8 +32,8 @@ enum option_on_off {
/* IOCTL structs and commands */
/**
- * struct pi433_tx_config
- * describes the configuration of the radio module for sending
+ * struct pi433_tx_cfg
+ * describes the configuration of the radio module for sending data
* @frequency:
* @bit_rate:
* @modulation:
@@ -46,7 +45,7 @@ enum option_on_off {
* @repetitions:
*
* ATTENTION:
- * If the contents of 'pi433_tx_config' ever change
+ * If the contents of 'pi433_tx_cfg' ever change
* incompatibly, then the ioctl number (see define below) must change.
*
* NOTE: struct layout is the same in 64bit and 32bit userspace.
@@ -81,8 +80,8 @@ struct pi433_tx_cfg {
};
/**
- * struct pi433_rx_config
- * describes the configuration of the radio module for sending
+ * struct pi433_rx_cfg
+ * describes the configuration of the radio module for receiving data
* @frequency:
* @bit_rate:
* @modulation:
@@ -94,7 +93,7 @@ struct pi433_tx_cfg {
* @repetitions:
*
* ATTENTION:
- * If the contents of 'pi433_rx_config' ever change
+ * If the contents of 'pi433_rx_cfg' ever change
* incompatibly, then the ioctl number (see define below) must change
*
* NOTE: struct layout is the same in 64bit and 32bit userspace.
--
2.25.4
Re: [PATCH] staging: pi433: fix ...
This is version 2. Subject needs to be [PATCH v2]. If you generate using
git format-patch add "-v 2" in there.
On Sat, Aug 28, 2021 at 10:12:42PM +1200, Paulo Miguel Almeida wrote:
> In the comments there where some grammar mistakes and references to
> struct names that have gotten renamed over time but not updated
> in the comments.
>
> Signed-off-by: Paulo Miguel Almeida <[email protected]>
> ---
You should have log here what did you change from previous version as
this is v2. You can also add who ask this change That should be like
this:
---
Put your version log here.
---
> drivers/staging/pi433/pi433_if.h | 23 +++++++++++------------
> 1 file changed, 11 insertions(+), 12 deletions(-)
>
> diff --git a/drivers/staging/pi433/pi433_if.h b/drivers/staging/pi433/pi433_if.h
> index d5c1521192c1..855f0bebdc1c 100644
> --- a/drivers/staging/pi433/pi433_if.h
> +++ b/drivers/staging/pi433/pi433_if.h
> @@ -5,14 +5,13 @@
> * userspace interface for pi433 radio module
> *
> * Pi433 is a 433MHz radio module for the Raspberry Pi.
> - * It is based on the HopeRf Module RFM69CW. Therefore inside of this
> - * driver, you'll find an abstraction of the rf69 chip.
> + * It is based on the HopeRf Module RFM69CW. Therefore, inside of this
> + * driver you'll find an abstraction of the rf69 chip.
> *
> - * If needed, this driver could be extended, to also support other
> - * devices, basing on HopeRfs rf69.
> + * If needed this driver could also be extended to support other
> + * devices based on HopeRf rf69 as well as HopeRf modules with a similar
> + * interface such as RFM69HCW, RFM12, RFM95 and so on.
> *
> - * The driver can also be extended, to support other modules of
> - * HopeRf with a similar interace - e. g. RFM69HCW, RFM12, RFM95, ...
> * Copyright (C) 2016 Wolf-Entwicklungen
> * Marcus Wolf <[email protected]>
> */
> @@ -33,8 +32,8 @@ enum option_on_off {
> /* IOCTL structs and commands */
>
> /**
> - * struct pi433_tx_config
> - * describes the configuration of the radio module for sending
> + * struct pi433_tx_cfg
> + * describes the configuration of the radio module for sending data
> * @frequency:
> * @bit_rate:
> * @modulation:
> @@ -46,7 +45,7 @@ enum option_on_off {
> * @repetitions:
> *
> * ATTENTION:
> - * If the contents of 'pi433_tx_config' ever change
> + * If the contents of 'pi433_tx_cfg' ever change
> * incompatibly, then the ioctl number (see define below) must change.
> *
> * NOTE: struct layout is the same in 64bit and 32bit userspace.
> @@ -81,8 +80,8 @@ struct pi433_tx_cfg {
> };
>
> /**
> - * struct pi433_rx_config
> - * describes the configuration of the radio module for sending
> + * struct pi433_rx_cfg
> + * describes the configuration of the radio module for receiving data
> * @frequency:
> * @bit_rate:
> * @modulation:
> @@ -94,7 +93,7 @@ struct pi433_tx_cfg {
> * @repetitions:
> *
> * ATTENTION:
> - * If the contents of 'pi433_rx_config' ever change
> + * If the contents of 'pi433_rx_cfg' ever change
> * incompatibly, then the ioctl number (see define below) must change
> *
> * NOTE: struct layout is the same in 64bit and 32bit userspace.
> --
> 2.25.4
>
On Sat, Aug 28, 2021 at 01:23:02PM +0300, Kari Argillander wrote:
>
> Re: [PATCH] staging: pi433: fix ...
>
> This is version 2. Subject needs to be [PATCH v2]. If you generate using
> git format-patch add "-v 2" in there.
>
> On Sat, Aug 28, 2021 at 10:12:42PM +1200, Paulo Miguel Almeida wrote:
> > In the comments there where some grammar mistakes and references to
> > struct names that have gotten renamed over time but not updated
> > in the comments.
> >
> > Signed-off-by: Paulo Miguel Almeida <[email protected]>
> > ---
>
> You should have log here what did you change from previous version as
> this is v2. You can also add who ask this change That should be like
> this:
>
> ---
> Put your version log here.
> ---
>
I see. Will do, thanks Kari :-)