Re: [PATCH][TEST-CASE][DOC] Implementation of pipe to pass GDB's command output to the shell.

Eli Zaretskii
2011-08-30T18:07:38Z

> 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{ }} acts as a delimiter. The output of

Just @samp{ }, 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.