From 6bcba277578996d36d82b6ae5597d9e452f63e7e Mon Sep 17 00:00:00 2001
From: Evgenii Stratonikov <e.stratonikov@yadro.com>
Date: Tue, 8 Aug 2023 18:14:21 +0300
Subject: [PATCH] [#578] gendoc: Remove flag shorthands
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>
---
debian/rules | 4 ++--
pkg/util/gendoc/gendoc.go | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/debian/rules b/debian/rules
index b85356b99..0dd8ee399 100755
--- a/debian/rules
+++ b/debian/rules
@@ -12,8 +12,8 @@ override_dh_auto_install:
echo $(DEB_BUILD_OPTIONS)
dh_auto_install
- bin/frostfs-adm gendoc -t man man/
- bin/frostfs-cli gendoc -t man man/
+ bin/frostfs-adm gendoc --type man man/
+ bin/frostfs-cli gendoc --type man man/
bin/frostfs-adm completion bash > debian/frostfs-adm.bash-completion
bin/frostfs-cli completion bash > debian/frostfs-cli.bash-completion
diff --git a/pkg/util/gendoc/gendoc.go b/pkg/util/gendoc/gendoc.go
index 16ebe9f98..5da211e2b 100644
--- a/pkg/util/gendoc/gendoc.go
+++ b/pkg/util/gendoc/gendoc.go
@@ -93,9 +93,9 @@ In this case there is a number of helper functions which can be used:
}
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.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
}