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

Auto-generate sysvar documentation from TiDB server source #5720

Draft
wants to merge 56 commits into
base: master
Choose a base branch
from

Conversation

morgo
Copy link
Contributor

@morgo morgo commented May 28, 2021

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)

  • master (the latest development version)
  • v5.1 (TiDB 5.1 versions)
  • 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)?

  • 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

@ti-chi-bot
Copy link
Member

ti-chi-bot commented May 28, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • dveeden

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot requested a review from TomShawn May 28, 2021 15:12
@ti-chi-bot ti-chi-bot added the missing-translation-status This PR does not have translation status info. label May 28, 2021
@morgo morgo changed the title Fix sysvar correctness Auto-generate sysvar documentation from TiDB server source May 28, 2021
@ti-chi-bot ti-chi-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 28, 2021
@TomShawn
Copy link
Contributor

TomShawn commented May 31, 2021

@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.

@TomShawn TomShawn assigned bb7133 and zz-jason and unassigned bb7133 and zz-jason May 31, 2021
@TomShawn TomShawn requested review from zz-jason and bb7133 May 31, 2021 11:08
@TomShawn TomShawn added the translation/doing This PR's assignee is translating this PR. label May 31, 2021
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label May 31, 2021
@morgo
Copy link
Contributor Author

morgo commented May 31, 2021

@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+

@TomShawn TomShawn added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 1, 2021
@zz-jason zz-jason removed their request for review April 6, 2022 07:50
@TomShawn TomShawn added translation/no-need No need to translate this PR. and removed translation/doing This PR's assignee is translating this PR. labels Jan 16, 2023
@lilin90 lilin90 assigned Oreoxmt and unassigned TomShawn Mar 20, 2023
@qiancai
Copy link
Collaborator

qiancai commented Jul 7, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/LGT1 Indicates that a PR has LGTM 1. translation/no-need No need to translate this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants