diff options
| author | Daniel Silverstone <dsilvers@digital-scurf.org> | 2017-01-02 16:15:52 +0000 |
|---|---|---|
| committer | Daniel Silverstone <dsilvers@digital-scurf.org> | 2017-01-02 16:15:52 +0000 |
| commit | 23267884d1c127a062a91020e70085d7f807949e (patch) | |
| tree | e719a56067e848bc94c6cde000b2f69e2097e532 /testing | |
| parent | 22dfcb27fa1e47d333238ed0ffad17a268b09351 (diff) | |
| download | gitano-23267884d1c127a062a91020e70085d7f807949e.tar.gz | |
Add some notes to the help yarn
Diffstat (limited to 'testing')
| -rw-r--r-- | testing/02-commands-help.yarn | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/testing/02-commands-help.yarn b/testing/02-commands-help.yarn index 65111cb..101747e 100644 --- a/testing/02-commands-help.yarn +++ b/testing/02-commands-help.yarn @@ -1,5 +1,14 @@ <!-- -*- markdown -*- --> +Getting help +============ + +"A tool without documentation is no tool at all" -- Said someone at some point. + +Gitano has built-in help text for all its commands. Some may be perfunctory +and some may need extra context (hence we have the wiki) but we do, at least, +have help available for them all... + SCENARIO help is given GIVEN a standard instance @@ -29,8 +38,6 @@ THEN the output is not empty WHEN testinstance adminkey runs help git-receive-pack THEN the output is not empty - WHEN testinstance adminkey runs help git-upload-archive - THEN the output is not empty WHEN testinstance adminkey runs help git-upload-pack THEN the output is not empty WHEN testinstance adminkey runs help graveyard @@ -45,15 +52,22 @@ THEN the output is not empty WHEN testinstance adminkey runs help rename THEN the output is not empty - WHEN testinstance adminkey runs help rsync - THEN the output is not empty WHEN testinstance adminkey runs help sshkey THEN the output is not empty WHEN testinstance adminkey runs help user THEN the output is not empty WHEN testinstance adminkey runs help whoami THEN the output is not empty + +Even the plugins can define commands, so lets check they produce help too.. + + WHEN testinstance adminkey runs help rsync + THEN the output is not empty WHEN testinstance adminkey runs help demo THEN the output is not empty + WHEN testinstance adminkey runs help git-upload-archive + THEN the output is not empty + WHEN testinstance adminkey runs help git-annex-shell + THEN the output is not empty FINALLY the instance is torn down |