Project

General

Profile

Actions

Bug #2686

closed

Fancy Quotes in Documentation

Added by Kenneth Kolano over 5 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Target version:
Affected Versions:
Effort:
Difficulty:
Label:

Description

It seems that standard (i.e. ASCII char 22) quotation marks were replaced by fancy quotes in the Payload Keywords, and possibly other, documentation.

https://suricata.readthedocs.io/en/latest/rules/payload-keywords.html#content

With some sections using completely different sets...

Fancy-quotes matched appropriately:

content:“a|0D|bc”;

Fancy-quote mixed with standard quote:

content:”|61 0D 62 63|";

Mismatched fancy quotes:

content:”a|0D|b|63|”;

Is that intentional (i.e. intended to show an indifference for quote types)? If so, that should probably be explicit stated instead.

Even if there is an indifference for quote types, the escaping described will be problematic...

“     |22|

...since it will convert a fancy quote into a standard one, which is likely inappropriate.

Actions #1

Updated by Victor Julien about 5 years ago

  • Status changed from New to Assigned
  • Assignee set to Travis Green
  • Target version set to 5.0beta1
Actions #2

Updated by Victor Julien almost 5 years ago

  • Target version changed from 5.0beta1 to 5.0rc1
Actions #3

Updated by Victor Julien almost 5 years ago

  • Assignee changed from Travis Green to OISF Dev
Actions #4

Updated by Andreas Herz over 4 years ago

https://github.com/OISF/suricata/pull/3901 I also converted the single ones as well.

Is there a good way to prevent this from future PRs?

Actions #5

Updated by Kenneth Kolano over 4 years ago

  • Avoid opening the rst files on editors that set fancy quotes
  • Avoid copy and paste from sources with fancy quotes
  • See if a check for fancy quotes can be added to in the continuous-integration checks
Actions #6

Updated by Andreas Herz over 4 years ago

Kenneth Kolano wrote:

  • Avoid opening the rst files on editors that set fancy quotes
  • Avoid copy and paste from sources with fancy quotes

This we can just suggest :)

Kenneth Kolano wrote:

  • See if a check for fancy quotes can be added to in the continuous-integration checks

This is what I would like to have

Actions #7

Updated by Victor Julien over 4 years ago

  • Status changed from Assigned to Closed
  • Assignee changed from OISF Dev to Andreas Herz
Actions

Also available in: Atom PDF