Skip to content

Conversation

@ti-srebot
Copy link
Contributor

cherry-pick #4342 to release-4.0


What is changed, added or deleted? (Required)

Change the synopsis sections of BACKUP, RESTORE and SHOW {BACKUPS|RESTORES} to use the ```ebnf+diagrm block introduced since pingcap/website-docs#83, replacing the original image-based sqlgrams (which files are deleted).

Output preview

1-fs8

The syntax diagrams are now rendered server-side as SVG when building (similar to SQLite3 / IBM DB2 / CockroachDB's docs), and user can also toggle between syntax diagram and the source EBNF (similar to Oracle's docs).

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

  • master (the latest development version)
  • 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)?

  • This PR is translated from:
  • Other reference 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

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot added size/small Changes of a small size. status/PTAL This PR is ready for reviewing. type/cherry-pick-for-release-4.0 This PR is cherry-picked to release-4.0 from a source PR. labels Dec 7, 2020
@ti-srebot
Copy link
Contributor Author

@kennytm please accept the invitation then you can push to the cherry-pick pull requests.
https://github.com/ti-srebot/docs/invitations

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Dec 7, 2020
@TomShawn TomShawn added require-LGT1 Indicates that the PR requires an LGTM. status/can-merge Indicates a PR has been approved by a committer. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Dec 7, 2020
@TomShawn TomShawn merged commit f0a72b7 into pingcap:release-4.0 Dec 7, 2020
@lilin90 lilin90 changed the title sql-statements: use ENBF to render syntax diagrams for BACKUP and RESTORE (#4342) sql-statements: use EBNF to render syntax diagrams for BACKUP and RESTORE (#4342) Dec 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

require-LGT1 Indicates that the PR requires an LGTM. size/small Changes of a small size. status/can-merge Indicates a PR has been approved by a committer. status/PTAL This PR is ready for reviewing. type/cherry-pick-for-release-4.0 This PR is cherry-picked to release-4.0 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants