Re: [Qemu-devel] [PATCH 2/3] eepro100: Better documentation for temporary data

[Andreas Färber]

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 <address@hidden>
> ---
> 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