Merge pull request ElektraInitiative#4433 from hannes99/fix_opts_docs

fix ElektraInitiative#4432: opts docs: use arg/help instead of arg/name
Netgear · Aug 17, 2022 · 7f3f343 · 7f3f343
2 parents 63e6fc4 + 091a1b6
commit 7f3f343
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/doc/news/_preparation_next_release.md b/doc/news/_preparation_next_release.md
@@ -241,7 +241,7 @@ you up-to-date with the multi-language support provided by Elektra.
 
 ### Tutorials
 
-- <<TODO>>
+- opts: use arg/help instead of arg/name _(@hannes99)_
 - <<TODO>>
 - <<TODO>>
 - <<TODO>>

diff --git a/doc/tutorials/command-line-options.md b/doc/tutorials/command-line-options.md
@@ -397,10 +397,10 @@ opt/#0 = i
 opt/#0/long = interactive
 opt/#0/arg = optional
 opt/#0/flagvalue = always
+opt/#0/arg/help = WHEN
 opt/#1 = I
 opt/#1/flagvalue = once
 opt/#1/arg = none
-opt/arg/name = WHEN
 description = prompt according to WHEN: never, once (-I), or always (-i); without WHEN, prompt always
 
 [singlefs]
@@ -416,7 +416,7 @@ description = do not treat '/' specially
 [preserve]
 opt/long = preserve-root
 opt/arg = optional
-opt/arg/name = all
+opt/arg/help = all
 opt/flagvalue = root
 description = do not remove '/' (default); with 'all', reject any command line argument on a separate device from its parent
 

diff --git a/examples/gopts.c b/examples/gopts.c
@@ -43,12 +43,12 @@ static KeySet * createSpec (void)
 			"prompt according to WHEN: never, once (-I), or always (-i), without WHEN, prompt always", KEY_META, "opt", "#1",
 			KEY_META, "opt/#0", "i", KEY_META, "opt/#0/arg", "optional", KEY_META, "opt/#0/flagvalue", "always", KEY_META,
 			"opt/#0/long", "interactive", KEY_META, "opt/#1", "I", KEY_META, "opt/#1/arg", "none", KEY_META, "opt/#1/flagvalue",
-			"once", KEY_META, "opt/arg/name", "WHEN", KEY_END),
+			"once", KEY_META, "opt/#0/arg/help", "WHEN", KEY_END),
 		keyNew (SPEC_BASE_KEY "/nopreserve", KEY_META, "description", "do not treat '/' specially", KEY_META, "opt/arg", "none",
 			KEY_META, "opt/long", "no-preserve-root", KEY_END),
 		keyNew (SPEC_BASE_KEY "/preserve", KEY_META, "description",
 			"do not remove '/' (default), with 'all', reject any command line argument on a separate device from its parent",
-			KEY_META, "opt/arg", "optional", KEY_META, "opt/arg/name", "all", KEY_META, "opt/flagvalue", "root", KEY_META,
+			KEY_META, "opt/arg", "optional", KEY_META, "opt/arg/help", "all", KEY_META, "opt/flagvalue", "root", KEY_META,
 			"opt/long", "preserve-root", KEY_END),
 		keyNew (SPEC_BASE_KEY "/recursive", KEY_META, "description", "remove directories and their contents recursively", KEY_META,
 			"opt", "#1", KEY_META, "opt/#0", "r", KEY_META, "opt/#0/arg", "none", KEY_META, "opt/#0/long", "recursive",

diff --git a/examples/opts.c b/examples/opts.c
@@ -31,12 +31,12 @@ static KeySet * createSpec (void)
 			"prompt according to WHEN: never, once (-I), or always (-i), without WHEN, prompt always", KEY_META, "opt", "#1",
 			KEY_META, "opt/#0", "i", KEY_META, "opt/#0/arg", "optional", KEY_META, "opt/#0/flagvalue", "always", KEY_META,
 			"opt/#0/long", "interactive", KEY_META, "opt/#1", "I", KEY_META, "opt/#1/arg", "none", KEY_META, "opt/#1/flagvalue",
-			"once", KEY_META, "opt/arg/name", "WHEN", KEY_END),
+			"once", KEY_META, "opt/#0/arg/help", "WHEN", KEY_END),
 		keyNew (SPEC_BASE_KEY "/nopreserve", KEY_META, "description", "do not treat '/' specially", KEY_META, "opt/arg", "none",
 			KEY_META, "opt/long", "no-preserve-root", KEY_END),
 		keyNew (SPEC_BASE_KEY "/preserve", KEY_META, "description",
 			"do not remove '/' (default), with 'all', reject any command line argument on a separate device from its parent",
-			KEY_META, "opt/arg", "optional", KEY_META, "opt/arg/name", "all", KEY_META, "opt/flagvalue", "root", KEY_META,
+			KEY_META, "opt/arg", "optional", KEY_META, "opt/arg/help", "all", KEY_META, "opt/flagvalue", "root", KEY_META,
 			"opt/long", "preserve-root", KEY_END),
 		keyNew (SPEC_BASE_KEY "/recursive", KEY_META, "description", "remove directories and their contents recursively", KEY_META,
 			"opt", "#1", KEY_META, "opt/#0", "r", KEY_META, "opt/#0/arg", "none", KEY_META, "opt/#0/long", "recursive",