From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 91794 invoked by alias); 19 Jun 2019 16:53:50 -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 91601 invoked by uid 89); 19 Jun 2019 16:53:50 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-5.8 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_1,SPF_PASS autolearn=ham version=3.3.1 spammy=U*gdb-patches, sk:gdb-pat, sk:gdbpat, H*r:4.82 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; Wed, 19 Jun 2019 16:53:48 +0000 Received: from fencepost.gnu.org ([2001:470:142:3::e]:41739) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hddqD-0004DP-D3; Wed, 19 Jun 2019 12:53:45 -0400 Received: from [176.228.60.248] (port=4415 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1hddq4-0001mY-K3; Wed, 19 Jun 2019 12:53:38 -0400 Date: Wed, 19 Jun 2019 16:53:00 -0000 Message-Id: <83lfxxqzy5.fsf@gnu.org> From: Eli Zaretskii To: Pedro Alves CC: gdb-patches@sourceware.org, philippe.waroquiers@skynet.be In-reply-to: <3e69e8c9-9025-90ec-e6f6-73e04bd22360@redhat.com> (message from Pedro Alves on Wed, 19 Jun 2019 16:46:23 +0100) Subject: Re: [PATCH v2 4/4] Introduce the "with" command References: <20190618003902.19805-1-palves@redhat.com> <20190618003902.19805-5-palves@redhat.com> <83sgs6sv44.fsf@gnu.org> <3e69e8c9-9025-90ec-e6f6-73e04bd22360@redhat.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-IsSubscribed: yes X-SW-Source: 2019-06/txt/msg00390.txt.bz2 > Cc: gdb-patches@sourceware.org, philippe.waroquiers@skynet.be > From: Pedro Alves > Date: Wed, 19 Jun 2019 16:46:23 +0100 > > >> +@cindex change default behavior of commands > >> +@cindex change default settings > > > > Two index entries that start with the same text and point to the same > > place are not useful. I'd drop the second one. > > I thought it was useful because someone skimming the > index might not relate "behavior of commands" to "settings" > and vice versa. (settings affect more than commands, like > e.g., they change how gdb reacts to inferior events, like forking.) > But looking at the resulting page, I have to agree with you, > at least the the repetition seems odd. > > Some settings use a comma to add some kind of context. > So how about doing something similar here, like: > > @cindex change default behavior of commands, settings > > ? I'd suggest to reorder the words of your original second entry: @cindex default settings, changing Then we can have both of these entries. > +If a @var{command} is provided, it must be preceded by a double dash > +(@code{--}) separator. This is required because some settings accept > +free-form arguments, such as expressions or filenames. > > As I had mentioned before, it may be we can make this delimiter > optional. Also, we may need a "with -separate SEP" option in > case someone wants to use an expression with "--" in it. However, > I'd rather leave it to a separate pass, as I don't want to spend > much more time on this at this point and the need for that should > be quite rare. OK. We can revisit the text when we get to that second pass. > SETTING is any GDB setting changeable with the "set" command. > > Do you have a better suggestion? Instead of "changeable", I'd use "you can change". Otherwise, SGTM. > + @var{value} is the value the setting is changed to while > +the command is run. Let's try to avoid passive tense, okay? @var{value} is the value to assign to @var{setting} while running @var{command}. WDYT? Thanks.