From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-154701-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 59620 invoked by alias); 18 Mar 2019 17:20:40 -0000
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
Received: (qmail 59612 invoked by uid 89); 18 Mar 2019 17:20:40 -0000
Authentication-Results: sourceware.org; auth=none
X-Spam-SWARE-Status: No, score=-6.1 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_1,SPF_PASS autolearn=ham version=3.3.1 spammy=
X-HELO: eggs.gnu.org
Received: from eggs.gnu.org (HELO eggs.gnu.org) (209.51.188.92) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 18 Mar 2019 17:20:39 +0000
Received: from fencepost.gnu.org ([2001:470:142:3::e]:42020)	by eggs.gnu.org with esmtp (Exim 4.71)	(envelope-from <eliz@gnu.org>)	id 1h5vwC-0006lv-UX; Mon, 18 Mar 2019 13:20:37 -0400
Received: from [176.228.60.248] (port=1319 helo=home-c4e4a596f7)	by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256)	(Exim 4.82)	(envelope-from <eliz@gnu.org>)	id 1h5vwC-0004bc-5j; Mon, 18 Mar 2019 13:20:36 -0400
Date: Mon, 18 Mar 2019 17:20:00 -0000
Message-Id: <83va0gumjp.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Andrew Burgess <andrew.burgess@embecosm.com>
CC: gdb-patches@sourceware.org, Richard.Bunt@arm.com
In-reply-to:	<854230b716fa6838bd2d8e73f1fd2d342a7a75ed.1552913183.git.andrew.burgess@embecosm.com>	(message from Andrew Burgess on Mon, 18 Mar 2019 12:52:16 +0000)
Subject: Re: [PATCH 1/8] gdb: Add $_cimag and $_creal internal functions
References: <cover.1552913183.git.andrew.burgess@embecosm.com> <cover.1552913183.git.andrew.burgess@embecosm.com> <854230b716fa6838bd2d8e73f1fd2d342a7a75ed.1552913183.git.andrew.burgess@embecosm.com>
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]
X-IsSubscribed: yes
X-SW-Source: 2019-03/txt/msg00389.txt.bz2

> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Cc: Richard Bunt <Richard.Bunt@arm.com>,	Andrew Burgess <andrew.burgess@embecosm.com>
> Date: Mon, 18 Mar 2019 12:52:16 +0000
> 
> gdb/ChangeLog:
> 
> 	* NEWS: Mention new internal functions.
> 	* dwarf2read.c (dwarf2_init_complex_target_type): New function.
> 	(read_base_type): Use dwarf2_init_complex_target_type.
> 	* value.c (creal_internal_fn): New function.
> 	(cimag_internal_fn): New function.
> 	(_initialize_values): Register new internal functions.
> 
> gdb/doc/ChangeLog:
> 
> 	* gdb.texinfo (Convenience Funs): Document '$_creal' and
> 	'$_cimag'.

The documentation parts are okay, with a couple of comments:

> +@item $_cimag(@var{value})
> +@findex $_cimag@r{, convenience function}
> +Return the imaginary part of a complex number @var{value}.
> +
> +The type of the imaginary part depends on the type of the complex
> +number, a @code{float complex} will return an imaginary part of type
> +@code{float}.
> +
> +@item $_creal(@var{value})
> +@findex $_creal@r{, convenience function}
> +Return the real part of a complex number @var{value}.
> +
> +The type of the real part depends on the type of the complex number, a
> +@code{float complex} will return an real part of type @code{float}.

There's no need to repeat the sentence about the type being dependent
on the original type; you can say that just once for both.

Also, the "a @code{float complex} will return ..." part is better
preceded by "e.g.", as this is an example, right?

And finally, "a real part", not "an real part".

> +Return the real part of a complex number, the type depends on the\n\
> +type of a complex number."),
           ^
"the", not "a".

> +Return the imaginary part of a complex number, the type depends on the\n\
> +type of a complex number."),

Likewise.

Thanks.