TrueCloudLab/frostfs-node
20
1
Fork 27
Code Issues 101 Pull requests 6 Projects Releases 1 Activity Actions

[#578] gendoc: Remove flag shorthands

Browse source 
Make it harder to encounter conflicts in already existing commands.
Because the command is executed once, I don't think the usability is
worse.

Signed-off-by: Evgenii Stratonikov <e.stratonikov@yadro.com>
This commit is contained in:
Evgenii Stratonikov 2023-08-08 18:14:21 +03:00
parent c800b64b12
commit 920c6117b6
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
debian/rules vendored
View file

@ -12,8 +12,8 @@ override_dh_auto_install:
echo $(DEB_BUILD_OPTIONS) echo $(DEB_BUILD_OPTIONS)
dh_auto_install dh_auto_install
bin/frostfs-adm gendoc -t man man/ bin/frostfs-adm gendoc --type man man/
bin/frostfs-cli gendoc -t man man/ bin/frostfs-cli gendoc --type man man/
bin/frostfs-adm completion bash > debian/frostfs-adm.bash-completion bin/frostfs-adm completion bash > debian/frostfs-adm.bash-completion
bin/frostfs-cli completion bash > debian/frostfs-cli.bash-completion bin/frostfs-cli completion bash > debian/frostfs-cli.bash-completion

4
pkg/util/gendoc/gendoc.go
View file

@ -93,9 +93,9 @@ In this case there is a number of helper functions which can be used:
} }
ff := gendocCmd.Flags() ff := gendocCmd.Flags()
ff.StringP(gendocTypeFlag, "t", gendocMarkdown, "Type for the documentation ('md' or 'man')") ff.String(gendocTypeFlag, gendocMarkdown, "Type for the documentation ('md' or 'man')")
ff.Int(depthFlag, 1, "If template is specified, unify all commands starting from depth in a single file. Default: 1.") ff.Int(depthFlag, 1, "If template is specified, unify all commands starting from depth in a single file. Default: 1.")
ff.StringP(extensionFlag, "e", "", "If the template is specified, string to append to the output file names") ff.String(extensionFlag, "", "If the template is specified, string to append to the output file names")
return gendocCmd return gendocCmd
} }