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

Rename application-handled -h CLI flags to -H #1743

Merged
merged 4 commits into from
Jan 7, 2022

Conversation

mzabaluev
Copy link
Contributor

@mzabaluev mzabaluev commented Jan 4, 2022

Closes: #1611

Description

Cherry-picked 60829af and re-enabled the built-in -h/--help flags.


PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests: integration (for Hermes) or unit/mock tests (for modules).
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

romac and others added 2 commits January 4, 2022 18:50
Since all application-assigned short -h options have been renamed to -H,
there is no need to suppress the -h flags provided by clap with the
DisableHelpFlag setting.
@mzabaluev mzabaluev added I: CLI Internal: related to the relayer's CLI needs guide update labels Jan 4, 2022
@romac romac merged commit b6b6536 into master Jan 7, 2022
@romac romac deleted the mikhail/rename-h-cli-flags branch January 7, 2022 10:37
mzabaluev added a commit that referenced this pull request Jan 10, 2022
* Disambiguate between help and height flags by using `-H` for the latter

* Enable clap-provided help flags on all subcommands

Since all application-assigned short -h options have been renamed to -H,
there is no need to suppress the -h flags provided by clap with the
DisableHelpFlag setting.

* Update changelog for #1743

* Remove a FIXME comment

Resolved by e59bb13

Co-authored-by: Romain Ruetschi <romain@informal.systems>
romac added a commit that referenced this pull request Jan 13, 2022
# v0.10.0

January 13th, 2021

This release notably updates the underlying CLI framework (`abscissa`) to version 0.6.0-beta.1,
which now uses `clap` for parsing command line arguments. This substantially improves the UX of the CLI,
by adding support for `--help` flags in subcommands and improving help and usage printouts.

The `--version` option of the `create channel` subcommand has been renamed
to `--channel-version`, with the old name still supported as an alias.
Additionally, the `-h` short flag on many commands is now `-H` to avoid
clashes with the clap-provided short flag for help.

This release also improves the handling of account sequence mismatch errors,
with a recovery mechanism to automatically retry or drop tx upon such errors.

The relayer now also supports dynamic versions in channel open handshake (which is needed by Interchain Accounts), and enables full support for IBC v2.

---

* Update package versions from v0.9.0 to v0.10.0

* Add changelog for #1656

* Bump `ibc-proto` version to 0.14.0

* Update guide wrt --help and --channel-version

* Disambiguate between help and height flags by using `-H` for the latter

* Update ibc-proto doc(html_root_url)

* Remove outdated comment

* Fix broken link in changelog

* Rename application-handled -h CLI flags to -H (#1743)

* Disambiguate between help and height flags by using `-H` for the latter

* Enable clap-provided help flags on all subcommands

Since all application-assigned short -h options have been renamed to -H,
there is no need to suppress the -h flags provided by clap with the
DisableHelpFlag setting.

* Update changelog for #1743

* Remove a FIXME comment

Resolved by e59bb13

Co-authored-by: Romain Ruetschi <romain@informal.systems>

* guide: Removed wording about missing -h/--help

The -h flags have been freed for built-in clap use and are supported
on all subcommands.

* Fix link to packet filtering policy in config page

* Release changelog for 0.10.0

* Update changelog summary

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Co-authored-by: Shoaib Ahmed <sufialhussaini@gmail.com>
Co-authored-by: Mikhail Zabaluev <mikhail@informal.systems>
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
* Disambiguate between help and height flags by using `-H` for the latter

* Enable clap-provided help flags on all subcommands

Since all application-assigned short -h options have been renamed to -H,
there is no need to suppress the -h flags provided by clap with the
DisableHelpFlag setting.

* Update changelog for informalsystems#1743

* Remove a FIXME comment

Resolved by e59bb13

Co-authored-by: Romain Ruetschi <romain@informal.systems>
hu55a1n1 added a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
# v0.10.0

January 13th, 2021

This release notably updates the underlying CLI framework (`abscissa`) to version 0.6.0-beta.1,
which now uses `clap` for parsing command line arguments. This substantially improves the UX of the CLI,
by adding support for `--help` flags in subcommands and improving help and usage printouts.

The `--version` option of the `create channel` subcommand has been renamed
to `--channel-version`, with the old name still supported as an alias.
Additionally, the `-h` short flag on many commands is now `-H` to avoid
clashes with the clap-provided short flag for help.

This release also improves the handling of account sequence mismatch errors,
with a recovery mechanism to automatically retry or drop tx upon such errors.

The relayer now also supports dynamic versions in channel open handshake (which is needed by Interchain Accounts), and enables full support for IBC v2.

---

* Update package versions from v0.9.0 to v0.10.0

* Add changelog for informalsystems#1656

* Bump `ibc-proto` version to 0.14.0

* Update guide wrt --help and --channel-version

* Disambiguate between help and height flags by using `-H` for the latter

* Update ibc-proto doc(html_root_url)

* Remove outdated comment

* Fix broken link in changelog

* Rename application-handled -h CLI flags to -H (informalsystems#1743)

* Disambiguate between help and height flags by using `-H` for the latter

* Enable clap-provided help flags on all subcommands

Since all application-assigned short -h options have been renamed to -H,
there is no need to suppress the -h flags provided by clap with the
DisableHelpFlag setting.

* Update changelog for informalsystems#1743

* Remove a FIXME comment

Resolved by e59bb13

Co-authored-by: Romain Ruetschi <romain@informal.systems>

* guide: Removed wording about missing -h/--help

The -h flags have been freed for built-in clap use and are supported
on all subcommands.

* Fix link to packet filtering policy in config page

* Release changelog for 0.10.0

* Update changelog summary

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Co-authored-by: Shoaib Ahmed <sufialhussaini@gmail.com>
Co-authored-by: Mikhail Zabaluev <mikhail@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: CLI Internal: related to the relayer's CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename CLI options ambiguous with clap-provided -h/--help and -V/--version
2 participants