-
Notifications
You must be signed in to change notification settings - Fork 688
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
Auto-generate sysvar documentation from TiDB server source #5720
base: master
Are you sure you want to change the base?
Conversation
[REVIEW NOTIFICATION] This pull request has been approved by:
To complete the pull request process, please ask the reviewers in the list to review by filling The full list of commands accepted by this bot can be found here. Reviewer can indicate their review by submitting an approval review. |
5710db3
to
24fc507
Compare
@morgo This is just awesome 😱! I guess this PR also applies to release-5.0, because the most majority of the content in release-5.0 is the same with that in master. |
That's actually complicated. The TiDB source code in release-5.0 does not support the required features to auto-generate. Only master does. I have also been fixing bugs based on the possible range of numeric types, so I think it's better to draw a line in the sand and say it only applies to docs in 5.1+ |
Removed the needs-cherry-pick-release-6.6 label because the v6.6 docs have been archived at https://docs-archive.pingcap.com/tidb/v6.6 and will no longer receive new updates. |
What is changed, added or deleted? (Required)
This auto-generates the system variables documentation by using the TiDB server's source code. The advantage of doing this is that system-variables will be guaranteed accurate, and non-documented sysvars will be automatically discovered.
It has a few small differences in formatting, but I've tried to keep it as close to the current document as makes sense.
** This contributes the script for future use by others. Generated system-variables.md files will be contributed separately. **
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?