diff mbox series

[i2c-tools,1/2] tools: i2ctransfer: consequently document -a

Message ID 20190311223335.18586-2-wsa+renesas@sang-engineering.com
State Accepted
Headers show
Series tools: improvements to handling restricted addresses | expand

Commit Message

Wolfram Sang March 11, 2019, 10:33 p.m. UTC
The text describing the address to be used did not reflect the recent
change where some of the functionality of '-f' has been seperated into
'-a'.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 CHANGES             | 1 +
 tools/i2ctransfer.8 | 8 +++++---
 2 files changed, 6 insertions(+), 3 deletions(-)

Comments

Jean Delvare March 15, 2019, 12:43 p.m. UTC | #1
Hi Wolfram,

On Mon, 11 Mar 2019 23:33:34 +0100, Wolfram Sang wrote:
> The text describing the address to be used did not reflect the recent
> change where some of the functionality of '-f' has been seperated into
> '-a'.
> 
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
> ---
>  CHANGES             | 1 +
>  tools/i2ctransfer.8 | 8 +++++---
>  2 files changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/CHANGES b/CHANGES
> index e2ea015..e9d46b5 100644
> --- a/CHANGES
> +++ b/CHANGES
> @@ -5,6 +5,7 @@ master
>    tools: Consistently use snprintf instead of sprintf
>    decode-dimms: Print SPD revision for DDR3 too
>                  Move SDR-specific code
> +  i2ctransfer: Mention '-a' everywhere in the manpage

Not sure how "once" qualifies as "everywhere" ;-)

>  
>  4.1 (2018-11-30)
>    Makefile: Make STRIP, DESTDIR and PREFIX overridable
> diff --git a/tools/i2ctransfer.8 b/tools/i2ctransfer.8
> index 5d3cc27..1f8ed82 100644
> --- a/tools/i2ctransfer.8
> +++ b/tools/i2ctransfer.8
> @@ -96,10 +96,12 @@ It is parsed as an unsigned 16 bit integer, but note that the Linux Kernel appli
>  specifies the 7-bit address of the chip to be accessed for this message, and is an integer.
>  If omitted, reuse the previous address.
>  Normally, addresses outside the range of 0x03-0x77 and addresses with a kernel driver attached to them will be blocked.
> -With
> +This can be overridden with
> +.I -a
> +(all) or
>  .I -f
> -(force), all addresses can be used.
> -Be very careful when using that!
> +(force).
> +Be very careful when using these!
>  10-bit addresses are currently not supported at all.
>  
>  .PP

Looks good to me.

Reviewed-by: Jean Delvare <jdelvare@suse.de>
Wolfram Sang March 17, 2019, 9:23 p.m. UTC | #2
> > +  i2ctransfer: Mention '-a' everywhere in the manpage
> 
> Not sure how "once" qualifies as "everywhere" ;-)

Yes, this patch changes it only once but after that it is everywhere :)
(It was mentioned in another place already)

> Looks good to me.
> 
> Reviewed-by: Jean Delvare <jdelvare@suse.de>

Thanks!
Wolfram Sang April 23, 2019, 9:13 p.m. UTC | #3
On Mon, Mar 11, 2019 at 11:33:34PM +0100, Wolfram Sang wrote:
> The text describing the address to be used did not reflect the recent
> change where some of the functionality of '-f' has been seperated into
> '-a'.
> 
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>

Applied to master.
diff mbox series

Patch

diff --git a/CHANGES b/CHANGES
index e2ea015..e9d46b5 100644
--- a/CHANGES
+++ b/CHANGES
@@ -5,6 +5,7 @@  master
   tools: Consistently use snprintf instead of sprintf
   decode-dimms: Print SPD revision for DDR3 too
                 Move SDR-specific code
+  i2ctransfer: Mention '-a' everywhere in the manpage
 
 4.1 (2018-11-30)
   Makefile: Make STRIP, DESTDIR and PREFIX overridable
diff --git a/tools/i2ctransfer.8 b/tools/i2ctransfer.8
index 5d3cc27..1f8ed82 100644
--- a/tools/i2ctransfer.8
+++ b/tools/i2ctransfer.8
@@ -96,10 +96,12 @@  It is parsed as an unsigned 16 bit integer, but note that the Linux Kernel appli
 specifies the 7-bit address of the chip to be accessed for this message, and is an integer.
 If omitted, reuse the previous address.
 Normally, addresses outside the range of 0x03-0x77 and addresses with a kernel driver attached to them will be blocked.
-With
+This can be overridden with
+.I -a
+(all) or
 .I -f
-(force), all addresses can be used.
-Be very careful when using that!
+(force).
+Be very careful when using these!
 10-bit addresses are currently not supported at all.
 
 .PP