From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 25995 invoked by alias); 9 Mar 2018 16:32:55 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 25980 invoked by uid 89); 9 Mar 2018 16:32:55 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-25.5 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,KAM_SHORT,T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 spammy= X-HELO: mx1.redhat.com Received: from mx3-rdu2.redhat.com (HELO mx1.redhat.com) (66.187.233.73) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 09 Mar 2018 16:32:53 +0000 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id CB512402277B; Fri, 9 Mar 2018 16:32:51 +0000 (UTC) Received: from localhost (unused-10-15-17-196.yyz.redhat.com [10.15.17.196]) by smtp.corp.redhat.com (Postfix) with ESMTP id ADF3A2026DFD; Fri, 9 Mar 2018 16:32:51 +0000 (UTC) From: Sergio Durigan Junior To: Andrew Burgess Cc: gdb-patches@sourceware.org Subject: Re: [PATCH] gdb: Fix riscv ARI issues References: <20180307224121.19941-1-andrew.burgess@embecosm.com> <871sgutqm9.fsf@redhat.com> <20180309104304.GA2671@embecosm.com> Date: Fri, 09 Mar 2018 16:32:00 -0000 In-Reply-To: <20180309104304.GA2671@embecosm.com> (Andrew Burgess's message of "Fri, 9 Mar 2018 10:43:05 +0000") Message-ID: <87po4dfbv0.fsf@redhat.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-IsSubscribed: yes X-SW-Source: 2018-03/txt/msg00198.txt.bz2 On Friday, March 09 2018, Andrew Burgess wrote: > Sergio, > > Thanks for taking the time to review my patch. I just wanted to > follow up on your feedback to help clarify the coding standard. Hi Andrew, > * Sergio Durigan Junior [2018-03-08 12:38:06 -0500]: > >> On Wednesday, March 07 2018, Andrew Burgess wrote: >>=20 >> > Fixes some ARI issues in recently added riscv code, the ARI email is: >> > >> > https://sourceware.org/ml/gdb-patches/2018-03/msg00156.html >>=20 >> Thanks for the patch, Andrew. Comment below. >>=20 >> > gdb/ChangeLog: >> > >> > * riscv-tdep.c (riscv_register_name): Use xsnprintf instead of >> > sprintf. >> > (riscv_insn::fetch_instruction): Use gdb_assert instead of >> > internal_error. >> > (riscv_print_arg_location): Use gdb_assert_not_reached instead of >> > error. >> > (riscv_push_dummy_call): Likewise. >> > --- >> > gdb/ChangeLog | 10 ++++++++++ >> > gdb/riscv-tdep.c | 14 ++++++-------- >> > 2 files changed, 16 insertions(+), 8 deletions(-) >> > >> > diff --git a/gdb/riscv-tdep.c b/gdb/riscv-tdep.c >> > index 11b12279321..d84e7aba76a 100644 >> > --- a/gdb/riscv-tdep.c >> > +++ b/gdb/riscv-tdep.c >> > @@ -481,7 +481,7 @@ riscv_register_name (struct gdbarch *gdbarch, int = regnum) >> > { >> > static char buf[20]; >> >=20=20 >> > - sprintf (buf, "csr%d", regnum - RISCV_FIRST_CSR_REGNUM); >> > + xsnprintf (buf, 20, "csr%d", regnum - RISCV_FIRST_CSR_REGNUM); >> > return buf; >> > } >> >=20=20 >> > @@ -1049,12 +1049,10 @@ riscv_insn::fetch_instruction (struct gdbarch = *gdbarch, >> >=20=20 >> > /* If we need more, grab it now. */ >> > instlen =3D riscv_insn_length (buf[0]); >> > + gdb_assert (instlen <=3D sizeof (buf)); >> > *len =3D instlen; >> > - if (instlen > sizeof (buf)) >> > - internal_error (__FILE__, __LINE__, >> > - _("%s: riscv_insn_length returned %i"), >> > - __func__, instlen); >> > - else if (instlen > 2) >> > + >> > + if (instlen > 2) >> > { >> > status =3D target_read_memory (addr + 2, buf + 2, instlen - 2); >> > if (status) >> > @@ -2009,7 +2007,7 @@ riscv_print_arg_location (ui_file *stream, struc= t gdbarch *gdbarch, >> > break; >> >=20=20 >> > default: >> > - error ("unknown argument location type"); >> > + gdb_assert_not_reached ("unknown argument location type"); >>=20 >> Strings must be marked for localization, with _(): >>=20 >> gdb_assert_not_reached (_("unknown argument location type")); >>=20 >> I also think it's a good thing to start the sentence with a capital >> letter. > > I referenced the GNU Standard here: > > https://www.gnu.org/prep/standards/standards.html#Errors > > Specifically these two paragraphs are I think relevant: > > "The string message should not begin with a capital letter when it > follows a program name and/or file name, because that isn=E2=80=99t t= he > beginning of a sentence. (The sentence conceptually starts at the > beginning of the line.) Also, it should not end with a period. > > Error messages from interactive programs, and other messages such > as usage messages, should start with a capital letter. But they > should not end with a period." > > Though GDB is clearly an interactive program and so the second > paragraph should apply, the 'gdb_assert_not_reached' does prefix the > message with some text like this: > > filename:line: internal-error: function: message > > So, to me, it feels like the first paragraph should apply and the > message should start with no capital letter. > > Further, a survey of the 157 uses of gdb_assert_not_reached show: > > 142 start with a lower case letter > 1 starts '...' > 7 start with a capital letter > 6 start with LOC_COMPUTED > 1 is the empty string > > So, should message strings that are going to be prefixed be > capitalised? Oh, I guess I stand corrected, then. > I'll fix the internationalisation as requested. Thanks, --=20 Sergio GPG key ID: 237A 54B1 0287 28BF 00EF 31F4 D0EB 7628 65FC 5E36 Please send encrypted e-mail if possible http://sergiodj.net/