Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation issue #184

Closed
pmetzger opened this issue Apr 19, 2017 · 3 comments
Closed

Small documentation issue #184

pmetzger opened this issue Apr 19, 2017 · 3 comments

Comments

@pmetzger
Copy link
Contributor

In the man page:

  re2c:yyfill:enable = 1;
         Set this to zero to suppress  generation  of  YYFILL  (n).  When
         using this be sure to verify that the generated scanner does not
         read behind input. Allowing this behavior might introduce  sever
         security issues to you programs.

You probably want this to read:

         Set this to zero to suppress  generation  of  YYFILL  (n).  When
         using this**,** be sure to verify that the generated scanner does not
         read **beyond** the **available** input. Allowing this behavior
         might introduce **severe** security issues to **your** programs.
@skvadrik
Copy link
Owner

I believe @pskocik recently fixed it in master. It now reads as:

Set this to zero to suppress the generation of YYFILL (n). When using this, be sure to verify that the generated scanner does not read behind the end of your input, allowing such behavior might introduce several security issues to your program.

However, if you think your variant is better, feel free to send a patch on top of master.
If you don't have time for that, in future please submit such minor documentation issues as a comment in #140.

@pmetzger
Copy link
Contributor Author

I don't have time right now, but I'll put a comment in #140. I think my variant is better, I don't think "several" is correct (severe was meant) and I don't think "behind" is correct (beyond is clearly the intended word).

@skvadrik
Copy link
Owner

Thank you! I will close this issue as a duplicate then.

pskocik added a commit to pskocik/re2c that referenced this issue Apr 20, 2017
pskocik added a commit to pskocik/re2c that referenced this issue Apr 20, 2017
skvadrik pushed a commit that referenced this issue Apr 20, 2017
skvadrik pushed a commit that referenced this issue Apr 20, 2017
skvadrik pushed a commit that referenced this issue Jul 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants