Re: [RFC, doc] fix document error on the grammar of GDB/MI output format syntax

[Joel Brobecker <brobecker@adacore.com>]

[-- Attachment #1: Type: text/plain, Size: 1074 bytes --]

> Looking at your patch.
> > -@code{[ @var{token} ] "+" @var{async-output}}
> > +@code{[ @var{token} ] "+" @var{async-output}} @var{nl}
> Is it OK to put the @var{nl} inside the @code{}?

OK, thank you and Eli for pointing this out and confirming it.
Attached is the updated patch.

> Because I see some (removed) code in your patch:
> > -@code{@var{async-class} ( "," @var{result} )* @var{nl}}
> I'm not familiar with the Texinfo grammar.

I won't say that I am extremely comfortable with it, yet,
but I'm slowly getting there...

Basically, the "nl" has been moved to the varous rules that
use this rule (exec-async-output, status-async-output and
notify-async-output). The idea is, as hinted in the patch's
rev log, to keep the special symbol indicating the type of
output, and the nl, within the same rule.

gdb/doc/ChangeLog:

        (from Yao Qi  <yao@codesourcery.com>)
        (from Joel Brobecker  <brobecker@adacore.com>)
        * gdb.texinfo (GDB/MI Output Syntax): Add some missing "nl"
        markers.  Remove one that was misplaced.

OK to apply?

-- 
Joel

[-- Attachment #2: 0001-Small-fixes-to-the-GDB-MI-Output-Syntax-grammar.patch --]
[-- Type: text/x-diff, Size: 2244 bytes --]

From a838547bbecd611cedd059911d95c6790871d63e Mon Sep 17 00:00:00 2001
From: Joel Brobecker <brobecker@adacore.com>
Date: Mon, 23 Dec 2013 04:25:14 +0400
Subject: [PATCH] Small fixes to the GDB/MI Output Syntax grammar.

This patch fixes the grammar, and tries to do it in a way that makes
the logic behind the current implementation a little clearer.

gdb/doc/ChangeLog:

        (from Yao Qi  <yao@codesourcery.com>)
        (from Joel Brobecker  <brobecker@adacore.com>)
        * gdb.texinfo (GDB/MI Output Syntax): Add some missing "nl"
        markers.  Remove one that was misplaced.
---
 gdb/doc/gdb.texinfo | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index b7551c2..f852c53 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -29166,16 +29166,16 @@ corresponding output for that command will also be prefixed by that same
 @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}
 
 @item @var{exec-async-output} @expansion{}
-@code{[ @var{token} ] "*" @var{async-output}}
+@code{[ @var{token} ] "*" @var{async-output nl}}
 
 @item @var{status-async-output} @expansion{}
-@code{[ @var{token} ] "+" @var{async-output}}
+@code{[ @var{token} ] "+" @var{async-output nl}}
 
 @item @var{notify-async-output} @expansion{}
-@code{[ @var{token} ] "=" @var{async-output}}
+@code{[ @var{token} ] "=" @var{async-output nl}}
 
 @item @var{async-output} @expansion{}
-@code{@var{async-class} ( "," @var{result} )* @var{nl}}
+@code{@var{async-class} ( "," @var{result} )*}
 
 @item @var{result-class} @expansion{}
 @code{"done" | "running" | "connected" | "error" | "exit"}
@@ -29207,13 +29207,13 @@ depending on the needs---this is still in development).
 @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}
 
 @item @var{console-stream-output} @expansion{}
-@code{"~" @var{c-string}}
+@code{"~" @var{c-string nl}}
 
 @item @var{target-stream-output} @expansion{}
-@code{"@@" @var{c-string}}
+@code{"@@" @var{c-string nl}}
 
 @item @var{log-stream-output} @expansion{}
-@code{"&" @var{c-string}}
+@code{"&" @var{c-string nl}}
 
 @item @var{nl} @expansion{}
 @code{CR | CR-LF}
-- 
1.8.3.2