This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Add crc32 function to libiberty


> Cc: gdb-patches@sourceware.org, dj@redhat.com
> From: Ian Lance Taylor <iant@google.com>
> Date: Fri, 24 Jul 2009 15:49:00 -0700

I have a couple of comments about the documentation:

> +@deftypefn Extension unsigned int crc32 (const unsigned char *@var{buf}, int @var{len}, unsigned int @var{init})
> +
> +Compute the 32-bit CRC of @var{buf} which has length @var{len}.  The
                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^
A minor stylistic comment: perhaps "whose length is @var{len}" is better.

> +protocol for the @samp{qCRC} command.  In order to get the same
> +results as gdb for a block of data, you must pass the first CRC
> +parameter as @code{0xffffffff}.

By "first CRC parameter", do you mean @var{init}?  If so, I suggest to
say that explicitly.

Finally, perhaps tell what the "CRC" acronym stands for, first time
you use it in the text.

Thanks.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]