Skip to content

Document 'tt cfg dump' #3722

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 19, 2023
Merged

Document 'tt cfg dump' #3722

merged 1 commit into from
Sep 19, 2023

Conversation

andreyaksenov
Copy link
Contributor

@andreyaksenov andreyaksenov commented Sep 18, 2023 •
edited
Loading

@andreyaksenov andreyaksenov linked an issue Sep 18, 2023 that may be closed by this pull request
tt cfg dump #3273
Closed
1 task
@andreyaksenov andreyaksenov force-pushed the tt-cfg-dump branch 5 times, most recently from 6e504f4 to 6729f92 Compare September 18, 2023 13:28
@andreyaksenov andreyaksenov requested a review from p7nov September 18, 2023 13:58
p7nov
p7nov approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@p7nov p7nov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple notes on command syntax.

doc/reference/tooling/tt_cli/cfg.rst Outdated

.. code-block:: bash

tt cfg [flags] <command> [command flags]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Since there are no cfg command flags at this time, maybe remove [flags] for simplicity?
  2. <command> should be COMMAND (upper case, no brackets) https://developers.google.com/style/code-syntax

We should generally align all CLI command syntax descriptions with Google or RedHat style guide, but it's a separate task.

@andreyaksenov andreyaksenov merged commit 2824070 into latest Sep 19, 2023
@andreyaksenov andreyaksenov deleted the tt-cfg-dump branch September 19, 2023 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@p7nov p7nov p7nov approved these changes

@psergee psergee psergee approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

tt cfg dump
3 participants
@andreyaksenov @p7nov @psergee