| Message ID | 5b34bc4e22816f7f19bd26c15a08fe4c749b72f8.1709316230.git.code@khaugsbakk.name (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 7a96b75e05953d377b42b01e171f884357772611 |
| Headers | show |
| Series | gitcli: drop mention of “non-dashed form” | expand |
Kristoffer Haugsbakk <code@khaugsbakk.name> writes: > ... These days though it seems like an irrelevant point to make to > budding CLI scripters—you don’t have to warn against a style that > probably doesn’t even work on their git(1) installation. It is very true. It is still technically correct that you should prefer spelling "git cat-file" instead of "git-cat-file", as the latter may not work for you at all ;-).
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index e5fac943227..7c709324ba9 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -81,9 +81,6 @@ you will. Here are the rules regarding the "flags" that you should follow when you are scripting Git: - * It's preferred to use the non-dashed form of Git commands, which means that - you should prefer `git foo` to `git-foo`. - * Splitting short options to separate words (prefer `git foo -a -b` to `git foo -ab`, the latter may not even work).
Git builtins used to be called like e.g. `git-commit`, not `git commit` (*dashed form* and *non-dashed form*, respectively). The dashed form was deprecated in version 1.5.4 (2006). Now only a few commands have an alternative dashed form when `SKIP_DASHED_BUILT_INS` is active.[1] The mention here is from 2f7ee089dff (parse-options: Add a gitcli(5) man page., 2007-12-13), back when the deprecation was relatively recent. These days though it seems like an irrelevant point to make to budding CLI scripters—you don’t have to warn against a style that probably doesn’t even work on their git(1) installation. † 1: 179227d6e21 (Optionally skip linking/copying the built-ins, 2020-09-21) Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- Notes (series): Now: ``` $ git grep --files-with-matches 'dashed form' Documentation/RelNotes/1.5.4.txt Documentation/RelNotes/2.16.0.txt Makefile t/README ``` For 179227d6e21 (Optionally skip linking/copying the built-ins, 2020-09-21): (sorry for the resend; I sent to my test address first) Cc: Johannes Schindelin <johannes.schindelin@gmx.de> Documentation/gitcli.txt | 3 --- 1 file changed, 3 deletions(-)