Skip to content

[vtadmin] Do not backtick binary name#11464

Merged
deepthi merged 1 commit intovitessio:mainfrom
planetscale:andrew/fix-vtadmin-help
Oct 13, 2022
Merged

[vtadmin] Do not backtick binary name#11464
deepthi merged 1 commit intovitessio:mainfrom
planetscale:andrew/fix-vtadmin-help

Conversation

@ajm188
Copy link
Copy Markdown
Contributor

@ajm188 ajm188 commented Oct 11, 2022

Description

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.

Related Issue(s)

rohit-nayak-ps/vreplication-docs#2 (review)

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Oct 11, 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.

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 andrew/fix-vtadmin-help branch from 9a1e4ed to d2084fa Compare October 12, 2022 18:06
@deepthi deepthi merged commit 9030aa6 into vitessio:main Oct 13, 2022
@deepthi deepthi deleted the andrew/fix-vtadmin-help branch October 13, 2022 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants