Merge pull request #247 from nuclearcat/help-tiny-fixes

Tiny fixes for cli help

Author: aliceinwire

docs/maestro-results.md

@@ -10,14 +10,14 @@ Do not use it, unless you are requesting test on Maestro through `kci-dev`.
 
 Example:
 ```sh
-kci-dev maestro-results --nodeid <str: testnodeid>
+kci-dev maestro results --nodeid <str: testnodeid>
 ```
 
 This command will show the results of tests by page nodes limit and page offset.
 
 Example:
 ```sh
-kci-dev maestro-results --nodes --limit <int: page nodes limit> --offset <int: page nodes offset>
+kci-dev maestro results --nodes --limit <int: page nodes limit> --offset <int: page nodes offset>
 ```
 
 Result sample:
@@ -82,15 +82,15 @@ Usually it is hexadecimal string.
 Additionally, for --nodes you can provide optional parameters --filter to filter the results by the given key and value.  
 For example:
 ```sh
-./kci-dev.py results --nodes --filter treeid=e25266f77837de335edba3c1b8d2a04edc2bfb195b77c44711d81ebea4494140 --filter kind=test
+kci-dev maestro results --nodes --filter treeid=e25266f77837de335edba3c1b8d2a04edc2bfb195b77c44711d81ebea4494140 --filter kind=test
 ```
 This command will show the nodes of tests in particular tree checkout.  
 But as you might see, there is a lot of fields you might be not interested in.  
 
 For this we have additional option --field, that will restrict output only to specified fields.  
 For example:
 ```sh
-./kci-dev.py results --nodes --filter treeid=e25266f77837de335edba3c1b8d2a04edc2bfb195b77c44711d81ebea4494140 --filter kind=test --field name --field result
+kci-dev maestro results --nodes --filter treeid=e25266f77837de335edba3c1b8d2a04edc2bfb195b77c44711d81ebea4494140 --filter kind=test --field name --field result
 ```
 Example:
 

kcidev/subcommands/maestro/validate/__init__.py

@@ -17,14 +17,14 @@
 \b
 Examples:
     # Validate builds
-    kci-dev validate builds --all-checkouts --days <number-of-days>
-    kci-dev validate builds -commit <git-commit> --giturl <git-url> --branch <git-branch>
+    kci-dev maestro validate builds --all-checkouts --days <number-of-days>
+    kci-dev maestro validate builds -commit <git-commit> --giturl <git-url> --branch <git-branch>
     # Validate boots
-    kci-dev validate boots --all-checkouts --days <number-of-days>
-    kci-dev validate boots -commit <git-commit> --giturl <git-url> --branch <git-branch>
+    kci-dev maestro validate boots --all-checkouts --days <number-of-days>
+    kci-dev maestro validate boots -commit <git-commit> --giturl <git-url> --branch <git-branch>
     # Validate builds history
-    kci-dev validate builds --history --all-checkouts --days <number-of-days> --arch <architecture-filter>
-    kci-dev validate builds --history -commit <git-commit> --giturl <git-url> --branch <git-branch> --days <number-of-days>
+    kci-dev maestro validate builds --history --all-checkouts --days <number-of-days> --arch <architecture-filter>
+    kci-dev maestro validate builds --history -commit <git-commit> --giturl <git-url> --branch <git-branch> --days <number-of-days>
 """,
     invoke_without_command=True,
 )

kcidev/subcommands/maestro/validate/boots.py

@@ -21,8 +21,8 @@
 
 \b
 Examples:
-    kci-dev validate boots --all-checkouts --days <number-of-days>
-    kci-dev validate boots -commit <git-commit> --giturl <git-url> --branch <git-branch>
+    kci-dev maestro validate boots --all-checkouts --days <number-of-days>
+    kci-dev maestro validate boots -commit <git-commit> --giturl <git-url> --branch <git-branch>
     """,
 )
 @click.option(

kcidev/subcommands/maestro/validate/builds.py

@@ -31,11 +31,11 @@
 \b
 Examples:
     # Build validation
-    kci-dev validate builds --all-checkouts --days <number-of-days>
-    kci-dev validate builds --commit <git-commit> --giturl <git-url> --branch <git-branch>
+    kci-dev maestro validate builds --all-checkouts --days <number-of-days>
+    kci-dev maestro validate builds --commit <git-commit> --giturl <git-url> --branch <git-branch>
     # Build history validation
-    kci-dev validate builds --history --all-checkouts --days <number-of-days>
-    kci-dev validate builds --history --giturl <git-url> --branch <git-branch> --days <number-of-days>
+    kci-dev maestro validate builds --history --all-checkouts --days <number-of-days>
+    kci-dev maestro validate builds --history --giturl <git-url> --branch <git-branch> --days <number-of-days>
 """,
 )
 @click.option(

kcidev/subcommands/results/__init__.py

@@ -818,17 +818,17 @@ def get_filtered_issues(origin, tree_name, giturl, branch, commit, arch):
   # Get issues
   kci-dev results issues --origin <origin> --days <number-of-days>
   # Get new issues for all checkouts
-  kci-dev issues --new --days <number-of-days> --origin <origin>
+  kci-dev results issues --new --days <number-of-days> --origin <origin>
   # Get new issues for a checkout
-  kci-dev issues --new --giturl <git-url> --branch <git-branch> --commit <commit> --origin <origin>
+  kci-dev results issues --new --giturl <git-url> --branch <git-branch> --commit <commit> --origin <origin>
   # Get failed or inconclusive builds and boots without any issue for all checkouts
-  kci-dev issues --missing
+  kci-dev results issues --missing
   # Get failed or inconclusive builds and boots without any issue for specific checkout
-  kci-dev issues --missing --giturl <git-url> --branch <git-branch> --commit <commit> --origin <origin>
+  kci-dev results issues --missing --giturl <git-url> --branch <git-branch> --commit <commit> --origin <origin>
   # Get failed/inconclusive builds without issues
-  kci-dev issues --missing --builds
+  kci-dev results issues --missing --builds
   # Get failed/inconclusive boots without issues
-  kci-dev issues --missing --boots
+  kci-dev results issues --missing --boots
 """,
 )
 @click.option(

kcidev/subcommands/testretry.py

@@ -55,12 +55,11 @@ def send_jobretry(baseurl, jobid, token):
 
 \b
 Examples:
-  # Retry a test job using its node ID
-  kci-dev testretry --nodeid 65a5c89f1234567890abcdef
-
-  # Get node ID from maestro-results and retry
-  kci-dev maestro-results --nodes --filter "status=fail" --field id --field name
-  kci-dev testretry --nodeid <NODE_ID_FROM_ABOVE>
+    kci-dev testretry --nodeid 65a5c89f1234567890abcdef
+    # If the user doesn't know the node id, they can query it using maestro results command
+    # for example, for failed tests:
+    kci-dev maestro results --nodes --filter "status=fail" --field id --field name
+    kci-dev testretry --nodeid <NODE_ID_FROM_ABOVE>
 """
 )
 @click.option(