From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-83341-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 7154 invoked by alias); 30 Aug 2011 14:27:47 -0000
Received: (qmail 7146 invoked by uid 22791); 30 Aug 2011 14:27:46 -0000
X-SWARE-Spam-Status: No, hits=-2.2 required=5.0	tests=AWL,BAYES_00,RP_MATCHES_RCVD
X-Spam-Check-By: sourceware.org
Received: from mail.codesourcery.com (HELO mail.codesourcery.com) (38.113.113.100)    by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 30 Aug 2011 14:27:25 +0000
Received: (qmail 10772 invoked from network); 30 Aug 2011 14:27:24 -0000
Received: from unknown (HELO scottsdale.localnet) (pedro@127.0.0.2)  by mail.codesourcery.com with ESMTPA; 30 Aug 2011 14:27:24 -0000
From: Pedro Alves <pedro@codesourcery.com>
To: Abhijit Halder <abhijit.k.halder@gmail.com>
Subject: Re: [PATCH][TEST-CASE][DOC] Implementation of pipe to pass GDB's command output to the shell.
Date: Tue, 30 Aug 2011 14:27:00 -0000
User-Agent: KMail/1.13.6 (Linux/2.6.38-11-generic; KDE/4.7.0; x86_64; ; )
Cc: Eli Zaretskii <eliz@gnu.org>, gdb-patches@sourceware.org, sergiodj@redhat.com, jan.kratochvil@redhat.com, tromey@redhat.com
References: <CAOhZP9wvFrF3z8SHSjot7grMtrkGcwFzXh8Te=qaA=1P4eYuFw@mail.gmail.com> <E1QxcLM-00006e-79@fencepost.gnu.org> <CAOhZP9xPqoGx8wV8=JRsvVS2jMEtOhu8NZ8RUeQ4DN+1KOfbzg@mail.gmail.com>
In-Reply-To: <CAOhZP9xPqoGx8wV8=JRsvVS2jMEtOhu8NZ8RUeQ4DN+1KOfbzg@mail.gmail.com>
MIME-Version: 1.0
Content-Type: Text/Plain;  charset="iso-8859-15"
Content-Transfer-Encoding: 7bit
Message-Id: <201108301527.22683.pedro@codesourcery.com>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2011-08/txt/msg00601.txt.bz2

On Tuesday 30 August 2011 14:58:02, Abhijit Halder wrote:
> +@table @code
> +@item pipe @var{args}

I suggest writing this as something like:

@item pipe @var{delim} @var{gdbcmd} @var{delim} @var{shellcmd}

and then adjust the text a bit to refer to the variables by name.
The syntax is more immediately obvious this way.

> +The @var{args} consists of a delimiter followed by a @value{GDBN} command,
> +followed by the same delimiter and finally a shell command.  The delimiter is a
> +string of arbitrary length, containing no whitespace and no leading '-', acts
> +as a separator between a @value{GDBN} command and a shell command.  The shell
> +command should be in compliance with the syntax of the default shell.
> +@end table

-- 
Pedro Alves