This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFAv2 6/6] NEWS and documentation for | (pipe) command.
> From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> Cc: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> Date: Fri, 26 Apr 2019 22:11:08 +0200
>
> +@item pipe [@var{command}] | @var{shell_command}
> +@itemx | [@var{command}] | @var{shell_command}
> +@item pipe -d@var{X} @var{command} @var{X} @var{shell_command}
> +@itemx | -d@var{X} @var{command} @var{X} @var{shell_command}
All but the first @item should be @itemx.
> +If the @var{command} contains a @code{|}, then the option @code{-d@var{X}}
> +can be used to specify an alternate character that separates
> +the @var{command} from the @var{shell_command}.
You didn't explain what X stands for. I suggest to say this instead:
... to specify an alternate character @var{X} that separates ...
Also, our convention is not to upcase the argument of @var; it is
upcased in the produced Info manual, but has a different typeface in
other formats.
> +@smallexample
> +(gdb) pipe p full|wc
> + 5 17 81
> +(gdb) |p full|wc -l
> +5
> +(gdb) p full
> +$4 = (black => 144,
> + red => 233,
> + green => 377,
> + blue => 610,
> + white => 987)
> +(gdb) ||grep red
> + red => 233,
> +(gdb) | -d! echo this contains a | char\n ! sed -e 's/|/PIPE/'
> +this contains a PIPE char
> +(gdb)
> +@end smallexample
This @example is very long, and could be split between two pages. In
order to give TeX a hint where to split it, use @group, like this:
@smallexample
@group
(gdb) pipe p full|wc
5 17 81
(gdb) |p full|wc -l
5
@end group
@group
(gdb) p full
$4 = (black => 144,
red => 233,
green => 377,
blue => 610,
white => 987)
(gdb) ||grep red
red => 233,
@end group
@group
(gdb) | -d! echo this contains a | char\n ! sed -e 's/|/PIPE/'
this contains a PIPE char
(gdb)
@end group
@end smallexample
(Feel free to divide differently into groups, but the principle is:
make a group of lines that you don't want split between pages.)
The documentation parts are OK with these nits fixed.
Thanks.