From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 7222 invoked by alias); 5 Apr 2013 18:40:12 -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 7213 invoked by uid 89); 5 Apr 2013 18:40:12 -0000 X-Spam-SWARE-Status: No, score=-4.3 required=5.0 tests=AWL,BAYES_00,KHOP_THREADED,RCVD_IN_DNSWL_NONE,RCVD_IN_HOSTKARMA_NO,RCVD_IN_HOSTKARMA_YE,SPF_SOFTFAIL autolearn=no version=3.3.1 Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169) by sourceware.org (qpsmtpd/0.84/v0.84-167-ge50287c) with ESMTP; Fri, 05 Apr 2013 18:40:09 +0000 Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0MKS00900P4OE900@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Fri, 05 Apr 2013 21:40:06 +0300 (IDT) Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MKS009T5P6UE210@a-mtaout21.012.net.il>; Fri, 05 Apr 2013 21:40:06 +0300 (IDT) Date: Fri, 05 Apr 2013 20:01:00 -0000 From: Eli Zaretskii Subject: Re: [doc patch] gdbserver.1: Document all the options and --multi In-reply-to: <20130405181316.GA3675@host2.jankratochvil.net> To: Jan Kratochvil Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83ppy8es8n.fsf@gnu.org> References: <20130405181316.GA3675@host2.jankratochvil.net> X-SW-Source: 2013-04/txt/msg00139.txt.bz2 > Date: Fri, 5 Apr 2013 20:13:16 +0200 > From: Jan Kratochvil > > patch is dependent on the pending patch: > Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 > http://sourceware.org/ml/gdb-patches/2013-04/msg00120.html > Message-ID: <20130405150101.GA15883@host2.jankratochvil.net> > > gdbserver man page was missing various parts. > > The text I usually took from their existing gdb.texinfo description although > I tried to make them more brief for the man page. Thanks. > That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only > -new command you need to know about is @code{target remote}. It's argument is either > +new command you need to know about is @code{target remote} > +(or @code{target extended-remote}. It's argument is either ^ ^^^^ First, that left parenthesis doesn't seem to have a matching right one. Also, you want "Its", not "It's". > +The three mode of executing @command{gdbserver} has the following three modes > +of execution. Hmmm... one of the "three modes" here should be removed, I think. > +The @var{comm} parameter always specifies how to communicate with @value{GDBN}, > +users typically use local TCP port 1234 specified as a @code{:1234} string. This should probably moved after the @table which describes the 3 modes, otherwise it gets in the way of the flow. Also, you can remove the identical text at the beginning of each mode sdescription: > +You have to supply how to communicate with @value{GDBN} (typically local TCP > +port @code{:1234}) It is enough to describe everything except the 'comm' parameter. > +In each of the modes one may specify these options: ^^^ It was "you" before; let's be consistent. > +@item --debug > +Enable @code{gdbserver} to display extra status information about the debugging > +process. "Enable ... to display" is not right. How about "Instruct" instead. > +@item --remote-debug > +Enable @code{gdbserver} to display remote protocol debug output. Likewise here.