[PATCH v3] i2c documentation: rename variable "register" to "reg"

[PATCH v3] i2c documentation: rename variable "register" to "reg"

[José Manuel Alarcón Roldán]

The example code provided with the i2c device interface documentation
won't compile since it uses the reserved word "register" to name a
variable.

The compiler fails with this error message:

 error: expected identifier or '(' before '=' token
   __u8 register = 0x20; /* Device register to access */
                 ^

Rename the variable "register" to simply "reg"
in the example code.

Signed-off-by: Jose Alarcon Roldan <jose.alarcon.roldan@gmail.com>
---
 Documentation/i2c/dev-interface | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
index 3e742ba..2ac78ae 100644
--- a/Documentation/i2c/dev-interface
+++ b/Documentation/i2c/dev-interface
@@ -57,12 +57,12 @@ Well, you are all set up now. You can now use
SMBus commands or plain
 I2C to communicate with your device. SMBus commands are preferred if
 the device supports them. Both are illustrated below.

-  __u8 register = 0x10; /* Device register to access */
+  __u8 reg = 0x10; /* Device register to access */
   __s32 res;
   char buf[10];

   /* Using SMBus commands */
-  res = i2c_smbus_read_word_data(file, register);
+  res = i2c_smbus_read_word_data(file, reg);
   if (res < 0) {
     /* ERROR HANDLING: i2c transaction failed */
   } else {
@@ -70,11 +70,11 @@ the device supports them. Both are illustrated below.
   }

   /* Using I2C Write, equivalent of
-     i2c_smbus_write_word_data(file, register, 0x6543) */
-  buf[0] = register;
+     i2c_smbus_write_word_data(file, reg, 0x6543) */
+  buf[0] = reg;
   buf[1] = 0x43;
   buf[2] = 0x65;
-  if (write(file, buf, 3) ! =3) {
+  if (write(file, buf, 3) != 3) {
     /* ERROR HANDLING: i2c transaction failed */
   }

-- 
1.9.1

Re: [PATCH v3] i2c documentation: rename variable "register" to "reg"

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 628 bytes --]

On Wed, Aug 27, 2014 at 10:54:21PM +0300, José Manuel Alarcón Roldán wrote:
> The example code provided with the i2c device interface documentation
> won't compile since it uses the reserved word "register" to name a
> variable.
> 
> The compiler fails with this error message:
> 
>  error: expected identifier or '(' before '=' token
>    __u8 register = 0x20; /* Device register to access */
>                  ^
> 
> Rename the variable "register" to simply "reg"
> in the example code.
> 
> Signed-off-by: Jose Alarcon Roldan <jose.alarcon.roldan@gmail.com>

Acked-by: Wolfram Sang <wsa@the-dreams.de>


[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [PATCH v3] i2c documentation: rename variable "register" to "reg"

[José Manuel Alarcón Roldán]

2014-08-27 22:54 GMT+03:00 José Manuel Alarcón Roldán
<jose.alarcon.roldan@gmail.com>:
> The example code provided with the i2c device interface documentation
> won't compile since it uses the reserved word "register" to name a
> variable.
>
> The compiler fails with this error message:
>
>  error: expected identifier or '(' before '=' token
>    __u8 register = 0x20; /* Device register to access */
>                  ^
>
> Rename the variable "register" to simply "reg"
> in the example code.
>
> Signed-off-by: Jose Alarcon Roldan <jose.alarcon.roldan@gmail.com>
> ---
>  Documentation/i2c/dev-interface | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
> index 3e742ba..2ac78ae 100644
> --- a/Documentation/i2c/dev-interface
> +++ b/Documentation/i2c/dev-interface
> @@ -57,12 +57,12 @@ Well, you are all set up now. You can now use
> SMBus commands or plain
>  I2C to communicate with your device. SMBus commands are preferred if
>  the device supports them. Both are illustrated below.
>
> -  __u8 register = 0x10; /* Device register to access */
> +  __u8 reg = 0x10; /* Device register to access */
>    __s32 res;
>    char buf[10];
>
>    /* Using SMBus commands */
> -  res = i2c_smbus_read_word_data(file, register);
> +  res = i2c_smbus_read_word_data(file, reg);
>    if (res < 0) {
>      /* ERROR HANDLING: i2c transaction failed */
>    } else {
> @@ -70,11 +70,11 @@ the device supports them. Both are illustrated below.
>    }
>
>    /* Using I2C Write, equivalent of
> -     i2c_smbus_write_word_data(file, register, 0x6543) */
> -  buf[0] = register;
> +     i2c_smbus_write_word_data(file, reg, 0x6543) */
> +  buf[0] = reg;
>    buf[1] = 0x43;
>    buf[2] = 0x65;
> -  if (write(file, buf, 3) ! =3) {
> +  if (write(file, buf, 3) != 3) {
>      /* ERROR HANDLING: i2c transaction failed */
>    }
>
> --
> 1.9.1

Again something went wrong. Sorry about that :-(

--
Jose

Re: [PATCH v3] i2c documentation: rename variable "register" to "reg"

[Randy Dunlap]

On 08/27/14 12:57, José Manuel Alarcón Roldán wrote:
> 2014-08-27 22:54 GMT+03:00 José Manuel Alarcón Roldán
> <jose.alarcon.roldan@gmail.com>:
>> The example code provided with the i2c device interface documentation
>> won't compile since it uses the reserved word "register" to name a
>> variable.
>>
>> The compiler fails with this error message:
>>
>>  error: expected identifier or '(' before '=' token
>>    __u8 register = 0x20; /* Device register to access */
>>                  ^
>>
>> Rename the variable "register" to simply "reg"
>> in the example code.
>>
>> Signed-off-by: Jose Alarcon Roldan <jose.alarcon.roldan@gmail.com>
>> ---
>>  Documentation/i2c/dev-interface | 10 +++++-----
>>  1 file changed, 5 insertions(+), 5 deletions(-)
>>
>> diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
>> index 3e742ba..2ac78ae 100644
>> --- a/Documentation/i2c/dev-interface
>> +++ b/Documentation/i2c/dev-interface
>> @@ -57,12 +57,12 @@ Well, you are all set up now. You can now use
>> SMBus commands or plain
>>  I2C to communicate with your device. SMBus commands are preferred if
>>  the device supports them. Both are illustrated below.
>>
>> -  __u8 register = 0x10; /* Device register to access */
>> +  __u8 reg = 0x10; /* Device register to access */
>>    __s32 res;
>>    char buf[10];
>>
>>    /* Using SMBus commands */
>> -  res = i2c_smbus_read_word_data(file, register);
>> +  res = i2c_smbus_read_word_data(file, reg);
>>    if (res < 0) {
>>      /* ERROR HANDLING: i2c transaction failed */
>>    } else {
>> @@ -70,11 +70,11 @@ the device supports them. Both are illustrated below.
>>    }
>>
>>    /* Using I2C Write, equivalent of
>> -     i2c_smbus_write_word_data(file, register, 0x6543) */
>> -  buf[0] = register;
>> +     i2c_smbus_write_word_data(file, reg, 0x6543) */
>> +  buf[0] = reg;
>>    buf[1] = 0x43;
>>    buf[2] = 0x65;
>> -  if (write(file, buf, 3) ! =3) {
>> +  if (write(file, buf, 3) != 3) {
>>      /* ERROR HANDLING: i2c transaction failed */
>>    }
>>
>> --
>> 1.9.1
> 
> Again something went wrong. Sorry about that :-(

What email client are you using?

-- 
~Randy

Re: [PATCH v3] i2c documentation: rename variable "register" to "reg"

[José Manuel Alarcón Roldán]

Gmail. I just had a look at Documentation/email-clients.txt I thought
that selected unformatted text mode would be enough, but obviously it
wasn't. My bad :-(

Will be more careful next time I send a patch. I will use something else.

--
Jose



2014-08-27 23:30 GMT+03:00 Randy Dunlap <rdunlap@infradead.org>:
> On 08/27/14 12:57, José Manuel Alarcón Roldán wrote:
>> 2014-08-27 22:54 GMT+03:00 José Manuel Alarcón Roldán
>> <jose.alarcon.roldan@gmail.com>:
>>> The example code provided with the i2c device interface documentation
>>> won't compile since it uses the reserved word "register" to name a
>>> variable.
>>>
>>> The compiler fails with this error message:
>>>
>>>  error: expected identifier or '(' before '=' token
>>>    __u8 register = 0x20; /* Device register to access */
>>>                  ^
>>>
>>> Rename the variable "register" to simply "reg"
>>> in the example code.
>>>
>>> Signed-off-by: Jose Alarcon Roldan <jose.alarcon.roldan@gmail.com>
>>> ---
>>>  Documentation/i2c/dev-interface | 10 +++++-----
>>>  1 file changed, 5 insertions(+), 5 deletions(-)
>>>
>>> diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
>>> index 3e742ba..2ac78ae 100644
>>> --- a/Documentation/i2c/dev-interface
>>> +++ b/Documentation/i2c/dev-interface
>>> @@ -57,12 +57,12 @@ Well, you are all set up now. You can now use
>>> SMBus commands or plain
>>>  I2C to communicate with your device. SMBus commands are preferred if
>>>  the device supports them. Both are illustrated below.
>>>
>>> -  __u8 register = 0x10; /* Device register to access */
>>> +  __u8 reg = 0x10; /* Device register to access */
>>>    __s32 res;
>>>    char buf[10];
>>>
>>>    /* Using SMBus commands */
>>> -  res = i2c_smbus_read_word_data(file, register);
>>> +  res = i2c_smbus_read_word_data(file, reg);
>>>    if (res < 0) {
>>>      /* ERROR HANDLING: i2c transaction failed */
>>>    } else {
>>> @@ -70,11 +70,11 @@ the device supports them. Both are illustrated below.
>>>    }
>>>
>>>    /* Using I2C Write, equivalent of
>>> -     i2c_smbus_write_word_data(file, register, 0x6543) */
>>> -  buf[0] = register;
>>> +     i2c_smbus_write_word_data(file, reg, 0x6543) */
>>> +  buf[0] = reg;
>>>    buf[1] = 0x43;
>>>    buf[2] = 0x65;
>>> -  if (write(file, buf, 3) ! =3) {
>>> +  if (write(file, buf, 3) != 3) {
>>>      /* ERROR HANDLING: i2c transaction failed */
>>>    }
>>>
>>> --
>>> 1.9.1
>>
>> Again something went wrong. Sorry about that :-(
>
> What email client are you using?
>
> --
> ~Randy