Patchwork [2/3] eepro100: Better documentation for temporary data

login
register
mail settings
Submitter Stefan Weil
Date Dec. 20, 2009, 3:52 p.m.
Message ID <1261324344-10642-2-git-send-email-weil@mail.berlios.de>
Download mbox | patch
Permalink /patch/41509/
State New
Headers show

Comments

Stefan Weil - Dec. 20, 2009, 3:52 p.m.
Michael S. Tsirkin suggested more documentation for
two temporary status values. Well, here it is.

Signed-off-by: Stefan Weil <weil@mail.berlios.de>
---
 hw/eepro100.c |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)
Andreas Färber - Dec. 20, 2009, 4:23 p.m.
Hello,

Am 20.12.2009 um 16:52 schrieb Stefan Weil:

> Michael S. Tsirkin suggested more documentation for
> two temporary status values. Well, here it is.
>
> Signed-off-by: Stefan Weil <weil@mail.berlios.de>
> ---
> hw/eepro100.c |    7 ++++---
> 1 files changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/hw/eepro100.c b/hw/eepro100.c
> index 5635f61..fb455a4 100644
> --- a/hw/eepro100.c
> +++ b/hw/eepro100.c
> @@ -213,9 +213,10 @@ typedef struct {
>     uint32_t ru_offset;         /* RU address offset */
>     uint32_t statsaddr;         /* pointer to eepro100_stats_t */
>
> -    /* Temporary data. */
> -    eepro100_tx_t tx;
> -    uint32_t cb_address;

Since you just introduced this in patch 1/3, please add the verbose  
documentation to the patch introducing these variables.

Andreas

> +    /* Temporary status information (no need to save these values),
> +     * used while processing CU commands. */
> +    eepro100_tx_t tx;           /* transmit buffer descriptor */
> +    uint32_t cb_address;        /* = cu_base + cu_offset */
>
>     /* Statistical counters. Also used for wake-up packet (i82559). */
>     eepro100_stats_t statistics;
> -- 
> 1.6.5
>
>
>
Stefan Weil - Dec. 20, 2009, 6:05 p.m.
Andreas Färber schrieb:
> Hello,
>
> Am 20.12.2009 um 16:52 schrieb Stefan Weil:
>
>> Michael S. Tsirkin suggested more documentation for
>> two temporary status values. Well, here it is.
>>
>> Signed-off-by: Stefan Weil <weil@mail.berlios.de>
>> ---
>> hw/eepro100.c |    7 ++++---
>> 1 files changed, 4 insertions(+), 3 deletions(-)
>>
>> diff --git a/hw/eepro100.c b/hw/eepro100.c
>> index 5635f61..fb455a4 100644
>> --- a/hw/eepro100.c
>> +++ b/hw/eepro100.c
>> @@ -213,9 +213,10 @@ typedef struct {
>>     uint32_t ru_offset;         /* RU address offset */
>>     uint32_t statsaddr;         /* pointer to eepro100_stats_t */
>>
>> -    /* Temporary data. */
>> -    eepro100_tx_t tx;
>> -    uint32_t cb_address;
>
> Since you just introduced this in patch 1/3, please add the verbose
> documentation to the patch introducing these variables.
>
> Andreas

Hi Andreas,

in this special case I won't resend the patch.
It was already sent too often :-)

Regards
Stefan

Patch

diff --git a/hw/eepro100.c b/hw/eepro100.c
index 5635f61..fb455a4 100644
--- a/hw/eepro100.c
+++ b/hw/eepro100.c
@@ -213,9 +213,10 @@  typedef struct {
     uint32_t ru_offset;         /* RU address offset */
     uint32_t statsaddr;         /* pointer to eepro100_stats_t */
 
-    /* Temporary data. */
-    eepro100_tx_t tx;
-    uint32_t cb_address;
+    /* Temporary status information (no need to save these values),
+     * used while processing CU commands. */
+    eepro100_tx_t tx;           /* transmit buffer descriptor */
+    uint32_t cb_address;        /* = cu_base + cu_offset */
 
     /* Statistical counters. Also used for wake-up packet (i82559). */
     eepro100_stats_t statistics;