Re: [PATCH 4/5] graphs: documentation

[Akim Demaille]

Le 18 oct. 2012 à 17:38, Theophile Ranquet a écrit :

> Note that 'make web-manual' fails.
> 
> * NEWS: Document these changes.
> * doc/Makefile.am: Adjust to generate example files.
> * doc/bison.texi: Add a Graphviz section after "Understanding::", the section
> describing the .output file, because these are similar.
> * doc/figs/example-reduce.dot, doc/figs/example-reduce.txt,
> doc/figs/example-shift.dot, doc/figs/example-shift.txt: New, minimal
> examples to illustrate the documentation.

Thanks, installed with this:

diff --git a/doc/figs/example-reduce.txt b/doc/figs/example-reduce.txt
index ec522cd..19df156 100644
--- a/doc/figs/example-reduce.txt
+++ b/doc/figs/example-reduce.txt
@@ -1,8 +1,8 @@
-      /*-----------------.
-      |     State 1      |
-      | 3 a: "0" . [";"] |
-      | 4 b: "0" . ["."] |
-      `-----------------*/
+        .------------------.
+        |     State 1      |
+        | 3 a: "0" . [";"] |
+        | 4 b: "0" . ["."] |
+        `------------------'
               /     \
              /       \ ["."]
             /         \
@@ -13,4 +13,3 @@
 (green) \ 3 /         \ 4 / (green)
          \ /           \ /
           .             .
-
diff --git a/doc/figs/example-shift.txt b/doc/figs/example-shift.txt
index f8d387d..43b1412 100644
--- a/doc/figs/example-shift.txt
+++ b/doc/figs/example-shift.txt
@@ -1,13 +1,12 @@
-/*---------------.
+.----------------.
 |    State 3     |
 | 1 exp: a . ";" |
-`----------------*/
-         |
-         | ";"
-         |
-         v
-/*---------------.
+`----------------'
+        |
+        | ";"
+        |
+        v
+.----------------.
 |    State 6     |
 | 1 exp: a ";" . |
-`---------------*/
-
+`----------------'


We also have to handle the use of dot from configure.
I guess we have to ship the generated files we rely on
to compile the documentation.  My duty.

But the documentation must also be clear about what happens
when there are conflicts (fixed or not).  Your duty :)
You should rely on the same grammar as the one used to
explain --verbose, in the previous section.