Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Abhijit Halder <abhijit.k.halder@gmail.com>
Cc: pedro@codesourcery.com, gdb-patches@sourceware.org,
	sergiodj@redhat.com, jan.kratochvil@redhat.com,
	tromey@redhat.com
Subject: Re: [PATCH][TEST-CASE][DOC] Implementation of pipe to pass GDB's command output to the shell.
Date: Tue, 30 Aug 2011 18:07:00 -0000	[thread overview]
Message-ID: <83y5yaepu4.fsf@gnu.org> (raw)
In-Reply-To: <CAOhZP9xsc2Q+7FapkWHcWv9TZihF1QBQJDgrLBTBjNbaHBu-og@mail.gmail.com>

> Date: Tue, 30 Aug 2011 22:08:22 +0530
> From: Abhijit Halder <abhijit.k.halder@gmail.com>
> Cc: Eli Zaretskii <eliz@gnu.org>, gdb-patches@sourceware.org, sergiodj@redhat.com, 
> 	jan.kratochvil@redhat.com, tromey@redhat.com
> 
> +	* gdb.texinfo (pipe command): New node.

You didn't write a new node, you just added text to the existing node.
So you should state the name of that node in the parentheses.

> +If you want to process the output of a @value{GDBN} command using some shell
> +command or some script, that can be done by using the command @code{pipe}.  You
> +don't even need to get a shell for that.  The same could be achieved by
> +enabling logging and redirecting the output of @value{GDBN} command to some
> +file and then processing the file content by invoking a shell using
> +@code{shell} command.  But this incurs higher costs as the explicit invokation
> +of shell involves execution of its startup scripts and locating the file
> +containing @value{GDBN}'s command output involves directory lookup; even though
> +OS may optimize these processes by its cache mechanism.

I would drop this part, and leave only the first sentence.  We don't
need to justify commands in the manual.

> +@table @code
> +@item pipe @var{dlim} @var{gdbcmd} @var{dlim} @var{shellcmd}

You need a "@kindex pipe" here, to index this command as we do with
all other commands.

> +@var{dlim} is a string of arbitrary length, containing no whitespace and no
> +leading '-', acts as a separator between a @value{GDBN} command @var{gdbcmd}
           ^^^
@samp{-}

> +In the above example @samp{@var{<br>}} acts as a delimiter.  The output of

Just @samp{<br>}, without @var.

> +@samp{print dd_tbl} is passed to the shell command @samp{sed 's/@}/\n/g' | @
> +grep ".test_dd" | tr ',' '\n'} for processing.

I would suggest to add that the example does not use `|' as a
delimiter to allow the shell command to use it in its usual shell
semantics.

> +In the given example the output of @value{GDBN} command is huge and not well
> +formated.  The use of shell commands like ``sed'', ``tr'' and ``grep'' ease

Please use @command{sed}, @command{tr}, etc.

Thanks.


  reply	other threads:[~2011-08-30 18:07 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-08-26 11:43 Abhijit Halder
2011-08-26 12:18 ` Eli Zaretskii
2011-08-28  8:52   ` Abhijit Halder
2011-08-28  9:25     ` Eli Zaretskii
2011-08-28  9:51     ` Eli Zaretskii
2011-08-28 10:12       ` Eli Zaretskii
2011-08-30 13:58         ` Abhijit Halder
2011-08-30 14:27           ` Pedro Alves
2011-08-30 14:32             ` Abhijit Halder
2011-08-30 14:49               ` Abhijit Halder
2011-08-30 16:38                 ` Abhijit Halder
2011-08-30 18:07                   ` Eli Zaretskii [this message]
2011-08-31  8:44                     ` Abhijit Halder
2011-08-31 11:01                       ` Eli Zaretskii
2011-08-31 12:42                         ` Abhijit Halder
2011-08-31 13:26                           ` Eli Zaretskii
2011-08-30 18:09                 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83y5yaepu4.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=abhijit.k.halder@gmail.com \
    --cc=gdb-patches@sourceware.org \
    --cc=jan.kratochvil@redhat.com \
    --cc=pedro@codesourcery.com \
    --cc=sergiodj@redhat.com \
    --cc=tromey@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox