From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 42759 invoked by alias); 12 Nov 2015 16:48:38 -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 42744 invoked by uid 89); 12 Nov 2015 16:48:37 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-0.9 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_SOFTFAIL autolearn=no version=3.3.2 X-HELO: mtaout22.012.net.il Received: from mtaout22.012.net.il (HELO mtaout22.012.net.il) (80.179.55.172) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 12 Nov 2015 16:48:35 +0000 Received: from conversion-daemon.a-mtaout22.012.net.il by a-mtaout22.012.net.il (HyperSendmail v2007.08) id <0NXP00K00NVO3V00@a-mtaout22.012.net.il> for gdb-patches@sourceware.org; Thu, 12 Nov 2015 18:48:32 +0200 (IST) Received: from HOME-C4E4A596F7 ([84.94.185.246]) by a-mtaout22.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0NXP00J1WO0VV270@a-mtaout22.012.net.il>; Thu, 12 Nov 2015 18:48:32 +0200 (IST) Date: Thu, 12 Nov 2015 16:48:00 -0000 From: Eli Zaretskii Subject: Re: [PATCH 3/3] Target remote mode fork and exec docs In-reply-to: <1447290000-31393-2-git-send-email-donb@codesourcery.com> To: Don Breazeal Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83mvuji2p9.fsf@gnu.org> References: <1447290000-31393-1-git-send-email-donb@codesourcery.com> <1447290000-31393-2-git-send-email-donb@codesourcery.com> X-IsSubscribed: yes X-SW-Source: 2015-11/txt/msg00278.txt.bz2 > From: Don Breazeal > Date: Wed, 11 Nov 2015 17:00:00 -0800 > > >> +@item > >> +Finally, connect to your target. For TCP connections, you must start up > >> +@code{gdbserver} prior to using the @kbd{target remote} or > >> +@kbd{target extended-remote} command. Otherwise you may get an error > >> +whose text depends on the host system, but which usually looks something > >> +like @samp{Connection refused}. Don't use the @code{load} command in > >> +@value{GDBN} when using @code{gdbserver}, since the program is already on > >> +the target. > > > > There's some inconsistency in your usage of @code and @kbd markup for > > commands. In general, the correct markup is @kbd when the context is > > about commands typed by the user, and @code otherwise. (The GDB > > manual almost never uses @kbd, for historical reasons, btw.) You have > > changed some of the @code to @kbd regardless of context, or so it > > seems. But in the above passage, you use @code as well, so I'm unsure > > what is your rule for selecting one or the other. > > I misunderstood the convention here. Thanks for clarifying. I think I > have more-or-less restored things. Basically, as I understand it, the rule > is: use @kbd where the sentence is saying "type @kbd{foo}" or "use > @kbd{foo}", but use @code if it is just referring to it, like "in the > case of the @code{foo} command". Yes, that's it. > +@table @asis > + > +@cindex remote debugging, detach and program exit > +@item Result of detach or program exit > + > +@strong{target remote mode:} When the debugged program exits or you > +detach from it, @value{GDBN} disconnects from the target. When using > +@code{gdbserver}, @code{gdbserver} will exit. > + > +@strong{target extended-remote mode:} When the debugged program exits or This is OK, but the fact that "target extended-remote mode:" part that begins a sentence doesn't start with a capital letter looks wrong. How about starting with @strong{With target extended-remote mode:} instead? > +@item The @code{run} command > +@strong{target remote mode:} The @code{run} command is not supported. Please be consistent regarding whether or not you leave an empty line after the @item line. (My suggestion is not to leave such a line in a @table.) > If you're using a serial line, you may want to give @value{GDBN} the > @samp{--baud} option, or use the @code{set serial baud} command > (@pxref{Remote Configuration, set serial baud}) before the > -@code{target} command. > +@kbd{target} command. Here you show 2 commands in the same sentence, one with @code, the other with @kbd. I think both should use @code. > +In @code{target extended-remote} mode, you can also attach using the > +@value{GDBN} attach command > +(@pxref{Types of Remote Connections: Attaching}). I don't understand this @pxref -- there's no such node or anchor in the text. Does this work for you? (Also, using a colon in cross-reference or node names is a bad idea, as that confuses Info readers.) The patch is approved, assuming the above minor issues are fixed. Thanks.