aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-rm.txt
diff options
context:
space:
mode:
authorStefan Beller <sbeller@google.com>2017-06-22 14:01:49 -0700
committerJunio C Hamano <gitster@pobox.com>2017-06-22 15:25:25 -0700
commitd48034551a3b1cb2dc60ff1c30a2d5acad20b6a1 (patch)
tree5893ba43894dce3ee0e2a752c4859fd741708436 /Documentation/git-rm.txt
parent41dd4330a1210003bd702ec4a9301ed68e60864d (diff)
downloadgit-d48034551a3b1cb2dc60ff1c30a2d5acad20b6a1.tar.gz
submodules: overhaul documentation
This patch aims to detangle (a) the usage of `git-submodule` from (b) the concept of submodules and (c) how the actual implementation looks like, such as where they are configured and (d) what the best practices are. To do so, move the conceptual parts of the 'git-submodule' man page to a new man page gitsubmodules(7). This new page is just like gitmodules(5), gitattributes(5), gitcredentials(7), gitnamespaces(7), gittutorial(7), which introduce a concept rather than explaining a specific command. Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-rm.txt')
-rw-r--r--Documentation/git-rm.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index f1efc116eb..db444693dd 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -152,8 +152,8 @@ Ignored files are deemed expendable and won't stop a submodule's work
tree from being removed.
If you only want to remove the local checkout of a submodule from your
-work tree without committing the removal,
-use linkgit:git-submodule[1] `deinit` instead.
+work tree without committing the removal, use linkgit:git-submodule[1] `deinit`
+instead. Also see linkgit:gitsubmodules[7] for details on submodule removal.
EXAMPLES
--------