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.

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

Add documentation to params.yaml #2010

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Add documentation to params.yaml #2010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion tools/config-gen/params.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
#################################### DOCUMENTATION STARTS ######################
# Params structure
# flag-name: Name of the CLI flag.
# config-path: Location of the param in the config file. A value of "gcs-auth.anonymous-access" indicates that the param will be present under the gcs-auth:anonymous-access.
# type: data type of the param - supports the following values: ["int", "float64", "bool", "string", "duration", "octal", "[]int",
# "[]string", "url", "logSeverity", "protocol", "resolvedPath"]
# usage: The usage doc that will appear in the helpdoc
# default: The default value of the param.
# deprecated: Specifies whether the param is deprecated. This will cause warnings when the user specifies the flag.
# deprecationWarning: The warning that should be issued when the user specifies a deprecated flag.
# hide-flag: Whether to hide flag from the helpdoc.
###################################### DOCUMENTATION ENDS ######################

- flag-name: "app-name"
config-path: "app-name"
type: "string"
Expand Down Expand Up @@ -352,7 +365,7 @@
- flag-name: "debug_gcs"
config-path: "debug.gcs"
type: "bool"
usage: "This flag is unused. Debug fuse logs are now controlled by log-severity flag, please use log-severity trace to view the logs."
usage: "This flag is unused. Debug GCS logs are now controlled by log-severity flag, please use log-severity trace to view the logs."
default: false
deprecated: true
deprecation-warning: "This flag is currently unused."
Expand Down
Loading