root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/util/markdownlint.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

30 lines
1.3 KiB
Ruby
Raw Normal View History

travis: enable markdownlint checks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
2020-05-07 19:42:14 +08:00
# markdownlint style rules for OpenSSL
# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
all
# Use --- and === for H1 and H2.
rule 'MD003', :style => :setext_with_atx
util/markdownlint.rb: Allow fenced code blocks We use both indented and fenced styles in diverse markdown files. We try to do this consistently in each file, though. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17933)
2022-03-21 23:23:09 +08:00
# Code blocks may be fenced or indented, both are OK...
# but they must be consistent throughout each file.
rule 'MD046', :style => :consistent
travis: enable markdownlint checks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
2020-05-07 19:42:14 +08:00
# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
exclude_rule 'MD007'
Adjust mdl configuration Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22405)
2023-10-16 22:50:30 +08:00
# Not possible to line-break tables (:tables => false)
# Not possible to line-break headers (currently cannot be selectively exempted)
exclude_rule 'MD013'
travis: enable markdownlint checks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
2020-05-07 19:42:14 +08:00
exclude_rule 'MD004' # Unordered list style TODO(fix?)
exclude_rule 'MD005' # Inconsistent indentation for list items at the same level
exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line
exclude_rule 'MD014' # Dollar signs used before commands without showing output
util/markdownlint.rb: Add two rule exceptions: MD023 and MD026 exclude_rule 'MD023' # Headers must start at the beginning of the line exclude_rule 'MD026' # Trailing punctuation in header Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12109)
2020-06-11 17:28:02 +08:00
exclude_rule 'MD023' # Headers must start at the beginning of the line
travis: enable markdownlint checks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
2020-05-07 19:42:14 +08:00
exclude_rule 'MD024' # Multiple headers with the same content
exclude_rule 'MD025' # Multiple top level headers in the same document
util/markdownlint.rb: Add two rule exceptions: MD023 and MD026 exclude_rule 'MD023' # Headers must start at the beginning of the line exclude_rule 'MD026' # Trailing punctuation in header Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12109)
2020-06-11 17:28:02 +08:00
exclude_rule 'MD026' # Trailing punctuation in header
travis: enable markdownlint checks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
2020-05-07 19:42:14 +08:00
exclude_rule 'MD029' # Ordered list item prefix
mdl: Don't enforce one space after list markers Common markdown styles usually show 4-column indents to separate the list marker and the list item text. That's a common template for writing new markdown files. On the other hand, we do have some files (such as CHANGES.md) where we use a different style. From a markdown perspective, both are perfectly OK, and there's no reason to enforce either. Therefore, the best thing is to exclude this particular rule. Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/18297)
2022-05-12 15:21:15 +08:00
exclude_rule 'MD030' # Spaces after list markers (default: 1!)
QUIC Connection State Machine Design Document Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/19452)
2022-10-20 14:37:01 +08:00
exclude_rule 'MD033' # Allow inline HTML (complex tables are impossible without it)