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

proxy-protocol possible values are not rendered correctly #16511

Open
yahonda opened this issue Feb 15, 2024 · 1 comment
Open

proxy-protocol possible values are not rendered correctly #16511

yahonda opened this issue Feb 15, 2024 · 1 comment

Comments

@yahonda
Copy link
Member

yahonda commented Feb 15, 2024

File: /master/tiproxy/tiproxy-configuration.md

https://docs.pingcap.com/tidb/dev/tiproxy-configuration#proxy-protocol shows the one of possible value is missing the closing backquote.

Possible values: `, v2`

The markdown itself looks correct https://github.com/pingcap/docs/blame/965c8767ee121c4bab722ee1e30a6c705481d8a5/tiproxy/tiproxy-configuration.md#L84

@kennytm
Copy link
Contributor

kennytm commented Jul 31, 2024

No the markdown is not correct. Commonmark allows inline code blocks to be surrounded by N+1 backquotes in order to display N backquotes inside, e.g.

Quote identifiers (schema/table/column names) with the `` ` `` character like ``SELECT * FROM `x`.`y`;``.

Therefore using `` will not work for empty strings. (But separating it like ` ` is also incorrect as this seems to suggest that a space is a valid input to proxy-protocol.)

The tidb-server page uses "" for empty strings, but they will also use "v2" for consistency.

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