From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 5111 invoked by alias); 8 Dec 2017 19:45:41 -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 107225 invoked by uid 89); 8 Dec 2017 19:45:27 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.6 required=5.0 tests=AWL,BAYES_00,SPF_PASS,T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 spammy=Hx-languages-length:2221, PDF, watch, understanding X-HELO: eggs.gnu.org Received: from eggs.gnu.org (HELO eggs.gnu.org) (208.118.235.92) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 08 Dec 2017 19:45:17 +0000 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eNOa8-0001Uv-4d for gdb-patches@sourceware.org; Fri, 08 Dec 2017 14:45:15 -0500 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:44387) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eNOa8-0001Up-18; Fri, 08 Dec 2017 14:45:12 -0500 Received: from [176.228.60.248] (port=3533 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eNOa6-0006UM-RO; Fri, 08 Dec 2017 14:45:11 -0500 Date: Fri, 08 Dec 2017 19:45:00 -0000 Message-Id: <83vahhuhqo.fsf@gnu.org> From: Eli Zaretskii To: Simon Marchi CC: gdb-patches@sourceware.org In-reply-to: <34fa897a804e9427dbe8ae3c107638e2@polymtl.ca> (message from Simon Marchi on Fri, 08 Dec 2017 12:59:31 -0500) Subject: Re: [PATCH] python doc: Rework Breakpoint.__init__ doc Reply-to: Eli Zaretskii References: <1512681799-12535-1-git-send-email-simon.marchi@ericsson.com> <83fu8lwbpa.fsf@gnu.org> <34fa897a804e9427dbe8ae3c107638e2@polymtl.ca> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-IsSubscribed: yes X-SW-Source: 2017-12/txt/msg00197.txt.bz2 > Date: Fri, 08 Dec 2017 12:59:31 -0500 > From: Simon Marchi > Cc: Simon Marchi , gdb-patches@sourceware.org > > We have a cross-reference for break and watch just above, is it > necessary to put them at every reference of those commands? No, not if they are close enough to one another. > Alternatively, instead of adding a "(see Setting Breakpoints)", for > example, is it possible to make the "break" word a link itself to the > documentation of break? This doesn't work well in some formats supported by Texinfo, so IMO it's best to avoid that. > It would work great for > HTML, PDF and info (formats with links), but not so much for plain text > formats. Actually, it works well for HTML, less well for Info, and not at all for PDF (because there are no hyperlinks in the printed version, only "See this and that"). > >> +The optional @var{type} argument denotes the breakpoint to create > >> from the types > >> +defined later in this chapter. This argument can be either > >> +@code{gdb.BP_BREAKPOINT} or @code{gdb.BP_WATCHPOINT}; it defaults to > >> +@code{gdb.BP_BREAKPOINT}. > > > > TYPE does not denote the breakpoint, it specifies its type. So > > suggest to reword" > > > > The optional @var{type} argument specifies the type of the > > breakpoint to create, as defined below. > > Done. I understand that we get rid of the second sentence (This > argument can be either...)? Not necessarily, you can keep it if you think it's useful. > > Btw, didn't you want to describe which combinations of these keywords > > are valid? Or maybe you should add a cross-reference to where that is > > described for the CLI commands. > > The important part is the fact that you can't use "spec" at the same > time as source/line/label/function. This should now be clear, because > they are defined in the two separate forms of gdb.Breakpoint(). Hmmm... now I'm confused: "at the same time" and "separate forms" sounds like a contradiction to me. My understanding was that one needs to choose which constructor to use: the first or the second, and then produce the spec accordingly. Isn't that so? Thanks.