You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2016/02/02 02:42:41 UTC
brooklyn-docs git commit: minor tweak to submodule instructions
Repository: brooklyn-docs
Updated Branches:
refs/heads/master 4e4aed4b5 -> eb38d4625
minor tweak to submodule instructions
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/eb38d462
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/eb38d462
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/eb38d462
Branch: refs/heads/master
Commit: eb38d462513c3b5a7cfaa912e240ae3fc24ead68
Parents: 4e4aed4
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Feb 2 01:41:31 2016 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Feb 2 01:41:31 2016 +0000
----------------------------------------------------------------------
guide/dev/code/index.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/eb38d462/guide/dev/code/index.md
----------------------------------------------------------------------
diff --git a/guide/dev/code/index.md b/guide/dev/code/index.md
index a589edf..e72ab20 100644
--- a/guide/dev/code/index.md
+++ b/guide/dev/code/index.md
@@ -27,9 +27,7 @@ Some options which may be useful:
* Use `--depth 1` with `git clone` to skip the history (much faster but your `git log` will be incomplete)
* Use `-DskipTests` with `mvn` to skip tests (again much faster but it won't catch failures)
-* Drop `--recursive` on the `git clone` and set up some submodules manually
- (e.g. with `git submodule init && git submodule update --remote [module]`)
- or avoid submodules, following the directions below
+* See below if you don't want to use submodules
Thereafter to update the code in submodules, we strongly recommend doing this:
@@ -39,7 +37,8 @@ This merges the latest upstream changes into the current branch of each sub-modu
giving nice errors on conflicts.
It's fine also to do branching and pulling in each submodule,
but running `update` without these parameters can cause chaos!
-This chaos -- and a `git sup` alias for this command -- are described in the [submodules](submodules.html) page.
+The [submodules](submodules.html) page will elaborate on potential chaos and pitfalls,
+and it provides instructions for setting up an alias `git sup` for this command.
### If You Can't Stand Submodules