From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-65641-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 7086 invoked by alias); 25 Jul 2009 07:16:44 -0000
Received: (qmail 6974 invoked by uid 22791); 25 Jul 2009 07:16:42 -0000
X-SWARE-Spam-Status: No, hits=-1.7 required=5.0 	tests=AWL,BAYES_00,SPF_SOFTFAIL
X-Spam-Check-By: sourceware.org
Received: from mtaout2.012.net.il (HELO mtaout2.012.net.il) (84.95.2.4)     by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Sat, 25 Jul 2009 07:16:29 +0000
Received: from conversion-daemon.i_mtaout2.012.net.il by i_mtaout2.012.net.il (HyperSendmail v2004.12) id <0KNB00F00T91UV00@i_mtaout2.012.net.il> for gdb-patches@sourceware.org; Sat, 25 Jul 2009 10:16:27 +0300 (IDT)
Received: from HOME-C4E4A596F7 ([84.228.68.240]) by i_mtaout2.012.net.il (HyperSendmail v2004.12) with ESMTPA id <0KNB00CZDTJEH6A0@i_mtaout2.012.net.il>; Sat, 25 Jul 2009 10:16:27 +0300 (IDT)
Date: Sat, 25 Jul 2009 07:27:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: Add crc32 function to libiberty
In-reply-to: <m363dh1yub.fsf@google.com>
To: Ian Lance Taylor <iant@google.com>
Cc: gcc-patches@gcc.gnu.org, gdb-patches@sourceware.org, dj@redhat.com
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83hbx144hh.fsf@gnu.org>
References: <m363dh1yub.fsf@google.com>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2009-07/txt/msg00620.txt.bz2

> 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.