Skip to content

sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and ANALYZE statements#5324

Merged
TomShawn merged 5 commits into
pingcap:masterfrom
CharLotteiu:ebnf-diagram-replace-patch-a
Jan 20, 2021
Merged

sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and ANALYZE statements#5324
TomShawn merged 5 commits into
pingcap:masterfrom
CharLotteiu:ebnf-diagram-replace-patch-a

Conversation

@CharLotteiu
Copy link
Copy Markdown
Contributor

@CharLotteiu CharLotteiu commented Jan 18, 2021 •
edited
Loading

What is changed, added or deleted? (Required)

This PR changes the synopsis sections of ADD, ALTER and ANALYZE statements to use the ```ebnf+diagrm block, replacing the original image-based sqlgrams. It is a follow-up PR to pingcap/docs#4389 and pingcap/docs#4342.

To avoid making one single PR too large, I will open 4-5 follow-up PRs to process sql-statements files in batches. And I will delete all image files in the last PR in case of any display issues.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@CharLotteiu CharLotteiu added needs-cherry-pick-3.1 status/PTAL This PR is ready for reviewing. translation/doing This PR’s assignee is translating this PR. labels Jan 18, 2021
@CharLotteiu CharLotteiu self-assigned this Jan 18, 2021
@CharLotteiu CharLotteiu added the requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. label Jan 18, 2021
@kennytm kennytm mentioned this pull request Jan 19, 2021
Closed
kennytm
kennytm reviewed Jan 19, 2021
View reviewed changes
Comment thread expression-syntax.md Outdated
Comment thread expression-syntax.md Outdated
Comment thread sql-statements/sql-statement-add-column.md Outdated
@kennytm
Copy link
Copy Markdown
Contributor

kennytm commented Jan 20, 2021

LGTM

@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jan 20, 2021

@kennytm, Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments. See the corresponding SIG page for more information. Related SIG: docs(slack).

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jan 20, 2021
@TomShawn
Copy link
Copy Markdown
Contributor

TomShawn commented Jan 20, 2021

@CharLotteiu Shall we remove the png files in this PR?

@CharLotteiu
Copy link
Copy Markdown
Contributor Author

CharLotteiu commented Jan 20, 2021

@CharLotteiu Shall we remove the png files in this PR?

I prefer to remove all png files in the last PR because some of the png files might still be used in other md files. What do you think?

@TomShawn TomShawn merged commit 59ffc3d into pingcap:master Jan 20, 2021
@CharLotteiu
Copy link
Copy Markdown
Contributor Author

CharLotteiu commented Jan 20, 2021

/run-cherry-picker

@ti-srebot ti-srebot mentioned this pull request Jan 20, 2021
Merged
10 tasks
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 20, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#5324 to release-2.1
b17c1f0 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jan 20, 2021

cherry pick to release-2.1 in PR #5352

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 20, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#5324 to release-3.0
81baa56 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 20, 2021
Merged
10 tasks
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jan 20, 2021

cherry pick to release-3.0 in PR #5353

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 20, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#5324 to release-3.1
3cbe8df 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 20, 2021
Merged
10 tasks
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jan 20, 2021

cherry pick to release-3.1 in PR #5354

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 20, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#5324 to release-4.0
bff3217 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 20, 2021
Merged
10 tasks
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jan 20, 2021

cherry pick to release-4.0 in PR #5355

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 20, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#5324 to release-5.0
afadc62 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 20, 2021
Merged
10 tasks
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jan 20, 2021

cherry pick to release-5.0 in PR #5356

CharLotteiu added a commit that referenced this pull request Jan 21, 2021
@ti-srebot @CharLotteiu @TomShawn
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
64a582b 
… ANALYZE statements (#5324) (#5355)

* cherry pick #5324 to release-4.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* Delete sql-statement-alter-index.md

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
CharLotteiu added a commit that referenced this pull request Jan 21, 2021
@ti-srebot @CharLotteiu
cherry pick #5324 to release-5.0 (#5356)
988c33c 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
CharLotteiu added a commit that referenced this pull request Jan 21, 2021
@ti-srebot @CharLotteiu
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
f0ac17c 
… ANALYZE statements (#5324) (#5352)

* cherry pick #5324 to release-2.1

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* resolve conflicts

* add missed ebnf code

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
TomShawn pushed a commit that referenced this pull request Jan 21, 2021
@ti-srebot @CharLotteiu
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
25f8707 
… ANALYZE statements (#5324) (#5353)

* cherry pick #5324 to release-3.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* resolve conflicts

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
TomShawn pushed a commit that referenced this pull request Jan 21, 2021
@ti-srebot @CharLotteiu
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
3f3961b 
… ANALYZE statements (#5324) (#5354)

* cherry pick #5324 to release-3.1

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* resolve conflicts

* revert delete

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
@CharLotteiu CharLotteiu mentioned this pull request Jan 25, 2021
Merged
10 tasks
@CharLotteiu CharLotteiu added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Jan 25, 2021
This was referenced Feb 1, 2021
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kennytm kennytm kennytm left review comments

+1 more reviewer

@TomShawn TomShawn TomShawn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@CharLotteiu CharLotteiu

Labels

requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. status/LGT1 Indicates that a PR has LGTM 1. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CharLotteiu @kennytm @ti-srebot @TomShawn