aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/gitsubmodules.txt
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2023-12-25 21:21:26 +0000
committerJunio C Hamano <gitster@pobox.com>2023-12-26 11:06:55 -0800
commit2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch)
tree9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/gitsubmodules.txt
parent055bb6e9969085777b7fab83e3fee0017654f134 (diff)
downloadgit-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.gz
doc: enforce dashes in placeholders
The CodingGuidelines documents stipulates that multi-word placeholders are to be separated by dashes, not underscores nor spaces. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitsubmodules.txt')
-rw-r--r--Documentation/gitsubmodules.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt
index 8400d591da..f7b5a25a0c 100644
--- a/Documentation/gitsubmodules.txt
+++ b/Documentation/gitsubmodules.txt
@@ -151,7 +151,7 @@ the superproject's `$GIT_DIR/config` file, so the superproject's history
is not affected. This can be undone using `git submodule init`.
* Deleted submodule: A submodule can be deleted by running
-`git rm <submodule path> && git commit`. This can be undone
+`git rm <submodule-path> && git commit`. This can be undone
using `git revert`.
+
The deletion removes the superproject's tracking data, which are
@@ -229,7 +229,7 @@ Workflow for a third party library
git submodule add <URL> <path>
# Occasionally update the submodule to a new version:
- git -C <path> checkout <new version>
+ git -C <path> checkout <new-version>
git add <path>
git commit -m "update submodule to new version"