From: helly <helly@642ea486-5414-0410-9d7f-a0204ed87703>
Date: Sat, 15 Apr 2006 11:58:34 +0000 (+0000)
Subject: - Update docu
X-Git-Tag: 0.13.6~401
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4c0554245b5df42df4e758d923ddc636f81eda52;p=re2c

- Update docu
---

diff --git a/htdocs/manual.html b/htdocs/manual.html
index 8f44ec7b..6a3bb54b 100755
--- a/htdocs/manual.html
+++ b/htdocs/manual.html
@@ -144,7 +144,7 @@ the last character in the buffer). The generated code repeatedly compares
 YYCURSOR to YYLIMIT to determine when the buffer needs (re)filling.<br /><br /></dd>
 <dt>YYMARKER</dt>
 <dd><i>l</i>-expression of type *YYCTYPE. The generated code saves backtracking
-information in YYMARKER.<br /><br /></dd>
+information in YYMARKER. Some easy scanners might not use this.<br /><br /></dd>
 <dt>YYCTXMARKER</dt>
 <dd><i>l</i>-expression of type *YYCTYPE. The generated code saves context 
 backtracking information in YYCTXMARKER. The user only  needs to define this 
@@ -155,7 +155,9 @@ regular expressions.<br /><br /></dd>
 least <i>n</i> additional characters should be provided. YYFILL should adjust
 YYCURSOR, YYLIMIT, YYMARKER and YYCTXMARKER as needed. Note that for typical 
 programming languages <i>n</i> will be the length of the longest keyword plus 
-one.<br /><br /></dd>
+one. The user can place a comment of the form /*!max:re2c */ after the 
+end of the last scanner block to insert a YYMAXFILL definition that is 
+set to the maximum length value.<br /><br /></dd>
 <dt>YYGETSTATE()</dt>
 <dd>The user only needs to define this macro if the <b>-f</b> flag was
 specified. In that case, the generated code "calls" YYGETSTATE at the very
diff --git a/re2c.1.in b/re2c.1.in
index 33e383a6..cc8d0ba0 100644
--- a/re2c.1.in
+++ b/re2c.1.in
@@ -7,6 +7,9 @@
 .ds rx regular expression
 .ds lx \fIl\fP-expression
 \"$Log$
+\"Revision 1.48  2006/04/15 11:58:34  helly
+\"- Update docu
+\"
 \"Revision 1.47  2006/04/15 11:50:21  helly
 \"- Update docu
 \"
@@ -324,7 +327,8 @@ to determine when the buffer needs (re)filling.
 .TP
 \fCYYMARKER\fP
 \*(lx of type \fC*YYCTYPE\fP.
-The generated code saves backtracking information in \fCYYMARKER\fP.
+The generated code saves backtracking information in \fCYYMARKER\fP. Some easy
+scanners might not use this.
 .TP
 \fCYYCTXMARKER\fP
 \*(lx of type \fC*YYCTYPE\fP.
@@ -338,6 +342,9 @@ The generated code "calls" \fCYYFILL\fP when the buffer needs
 be provided.  \fCYYFILL\fP should adjust \fCYYCURSOR\fP, \fCYYLIMIT\fP,
 \fCYYMARKER\fP and \fCYYCTXMARKER\fP as needed.  Note that for typical 
 programming languages \fIn\fP will be the length of the longest keyword plus one.
+The user can place a comment of the form \fC/*!max:re2c */\fP after the end of
+the last scanner block to insert a \fCYYMAXFILL\fP definition that is set to 
+the maximum length value.
 .TP
 \fCYYGETSTATE()\fP
 The user only needs to define this macro if the \fB-f\fP flag was specified.