File 0239-Update-some-vars-line-to-position-in-yecc-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0239-Update-some-vars-line-to-position-in-yecc-docs.patch of Package erlang (Revision ec1c7b677b97434a36bbda872e0ed27c)

Currently displaying revision ec1c7b677b97434a36bbda872e0ed27c , Show latest

From ecb744b22ad5471bcbed19693d37481905ae9fa9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C3=A9ter=20G=C3=B6m=C3=B6ri?=
 <gomoripeti@users.noreply.github.com>
Date: Fri, 26 Nov 2021 10:49:11 +0100
Subject: [PATCH] Update some vars (line to position) in yecc docs

The text already mentions "position (eg. line number)" and the spec also refers to location in
https://github.com/erlang/otp/blob/master/lib/parsetools/include/yeccpre.hrl#L50,
so this change is only to avoid any misunderstanding that the position must be a line number.
---
 lib/parsetools/doc/src/yecc.xml | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/lib/parsetools/doc/src/yecc.xml b/lib/parsetools/doc/src/yecc.xml
index 67847e5cc1..ba431b3b87 100644
--- a/lib/parsetools/doc/src/yecc.xml
+++ b/lib/parsetools/doc/src/yecc.xml
@@ -189,13 +189,13 @@
 text, and turns it into one or more lists of tokens. Each token
 should be a tuple containing information about syntactic
 category, position in the text (e.g. line number), and the
- actual terminal symbol found in the text: <c>{Category, LineNumber, Symbol}</c>.
+ actual terminal symbol found in the text: <c>{Category, Position, Symbol}</c>.
 If a terminal symbol is the only member of a category, and the
 symbol name is identical to the category name, the token format
- may be <c>{Symbol, LineNumber}</c>.
+ may be <c>{Symbol, Position}</c>.
 A list of tokens produced by the scanner should end with a
 special <c>end_of_input</c> tuple which the parser is looking
- for. The format of this tuple should be <c>{Endsymbol, LastLineNumber}</c>, where <c>Endsymbol</c> is an identifier
+ for. The format of this tuple should be <c>{Endsymbol, EndPosition}</c>, where <c>Endsymbol</c> is an identifier
 that is distinguished from all the terminal and non-terminal
 categories of the syntax rules. The <c>Endsymbol</c> may be
 declared in the grammar file (see below).
@@ -408,7 +408,7 @@ myparser:parse(myscanner:scan(Inport)) </code>
 default file <c>lib/parsetools/include/yeccpre.hrl</c>.
 With the standard prologue, this call will return either
 <c>{ok, Result}</c>, where <c>Result</c> is a structure that the
- Erlang code of the grammar file has built, or <c>{error, {Line_number, Module, Message}}</c> if there was a syntax error
+ Erlang code of the grammar file has built, or <c>{error, {Position, Module, Message}}</c> if there was a syntax error
 in the input.
 <c>Message</c> is something which may be converted into a
 string by calling <c>Module:format_error(Message)</c>
@@ -433,13 +433,13 @@ myparser:parse_and_scan({Mod, Tokenizer, Args}) </code>
 The tokenizer used above has to be implemented so as to return
 one of the following:
 <code type="none">
-{ok, Tokens, Endline}
-{eof, Endline}
-{error, Error_description, Endline} </code>
+{ok, Tokens, EndPosition}
+{eof, EndPosition}
+{error, Error_description, EndPosition} </code>
 This conforms to the format used by the scanner in the Erlang
 <c>io</c> library module.
- If <c>{eof, Endline}</c> is returned immediately, the call to
- <c>parse_and_scan/1</c> returns <c>{ok, eof}</c>. If <c>{eof, Endline}</c> is returned before the parser expects end of input,
+ If <c>{eof, EndPosition}</c> is returned immediately, the call to
+ <c>parse_and_scan/1</c> returns <c>{ok, eof}</c>. If <c>{eof, EndPosition}</c> is returned before the parser expects end of input,
 <c>parse_and_scan/1</c> will, of course, return an error message
 (see above). Otherwise <c>{ok, Result}</c> is returned.
 </section>
@@ -541,7 +541,7 @@ line_of(Token) ->
 rules, and an error is thrown (and caught by the generated
 parser to produce an error message) when a test fails. The
 same effect can be achieved with a call to
- <c>return_error(Error_line, Message_string)</c>, which is
+ <c>return_error(ErrorPosition, Message_string)</c>, which is
 defined in the <c>yeccpre.hrl</c> default header file.
 </note>
 </section>
-- 
2.31.1

Places

File 0239-Update-some-vars-line-to-position-in-yecc-docs.patch of Package erlang (Revision ec1c7b677b97434a36bbda872e0ed27c)

Places