[PATCH] - Added command synopsis in code and edited them in manual
- From
imyousuf@gmail.com <imyousuf@gmail.com>
- Date
- Mar 6, 2008, 07:33 UTC
- Message-ID
- <1204788817-22720-1-git-send-email-imyousuf@gmail.com>
From: Imran M Yousuf <imyousuf@smartitengineering.com>
Added the command synopsis so that they are available for any future command additions.
Quiet can also be specified using -q and it was missing in the usage in the code and man page.
In the init/update command synopsis either of them is required command as is add in its synopsis, so removed the square brackets around them from the documentation
Signed-off-by: Imran M Yousuf <imyousuf@smartitengineering.com> --- Documentation/git-submodule.txt | 6 +++--- git-submodule.sh | 6 +++++- 2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index e818e6e..595918e 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -9,9 +9,9 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- [verse] -'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>] -'git-submodule' [--quiet] status [--cached] [--] [<path>...] -'git-submodule' [--quiet] [init|update] [--] [<path>...] +'git-submodule' [-q|--quiet] add [-b branch] [--] <repository> [<path>] +'git-submodule' [-q|--quiet] [status] [--cached] [--] [<path>...] +'git-submodule' [-q|--quiet] init|update [--] [<path>...] COMMANDS diff --git a/git-submodule.sh b/git-submodule.sh index 67d3224..257be4c 100755 --- a/git-submodule.sh +++ b/git-submodule.sh @@ -4,7 +4,11 @@ # # Copyright (c) 2007 Lars Hjemli -USAGE='[--quiet] [--cached] [add <repo> [-b branch]|status|init|update] [--] [<path>...]' +# Synopsis of this commands are as follows +# git-submodule [-q|--quiet] add [-b|--branch branch] <repository> [<path>] +# git-submodule [-q|--quiet] [status] [-c|--cached] [--] [<path>...] +# git-submodule [-q|--quiet] init|update [--] [<path>...] +USAGE='[-q|--quiet] [--cached] [add <repo> [-b branch]|status|init|update] [--] [<path>...]' OPTIONS_SPEC= . git-sh-setup require_work_tree
-- 1.5.4.2