Skip to content

[release-15.0] [vtadmin] Do not backtick binary name (#11464)#11481

Merged
ajm188 merged 1 commit intorelease-15.0from
backport-11464-to-release-15.0
Oct 17, 2022
Merged

[release-15.0] [vtadmin] Do not backtick binary name (#11464)#11481
ajm188 merged 1 commit intorelease-15.0from
backport-11464-to-release-15.0

Conversation

@vitess-bot
Copy link
Contributor

@vitess-bot vitess-bot bot commented Oct 13, 2022

Description

This is a backport of #11464.

@vitess-bot
Copy link
Contributor Author

vitess-bot bot commented Oct 13, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@frouioui frouioui mentioned this pull request Oct 14, 2022
Closed
100 tasks
Do not backtick binary name
5efdb83 
I accidentally stumbled over the behavior outlined in
`flag.PrintDefaults` [1], which `pflag` replicates, specifically:

> The listed type, here int, can be changed by placing a back-quoted
> name in the flag's usage string; the first such item in the message is
> taken to be a parameter name to show in the message and the back quotes
> are stripped from the message when displayed.

[1]: https://pkg.go.dev/flag#PrintDefaults.

Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 force-pushed the backport-11464-to-release-15.0 branch from bb1df44 to 5efdb83 Compare October 14, 2022 13:55
@ajm188
Copy link
Contributor

ajm188 commented Oct 14, 2022

(i rebased on release-15.0 to pick up the test fix)

@ajm188 ajm188 merged commit 52c36e6 into release-15.0 Oct 17, 2022
@ajm188 ajm188 deleted the backport-11464-to-release-15.0 branch October 17, 2022 18:57
@austenLacy austenLacy mentioned this pull request Apr 26, 2023
Merged
@austenLacy austenLacy mentioned this pull request Aug 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@doeg doeg Awaiting requested review from doeg

@notfelineit notfelineit Awaiting requested review from notfelineit

1 more reviewer

@ajm188 ajm188 ajm188 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Backport This is a backport Component: CLI Component: VTAdmin VTadmin interface Type: Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ajm188