Update help, add convenience target git-submodule.
Makefile
--------
o Added convenience target git-submodule to help checkout
external repository dependencies.
o Update target help formatting in prep for display of
repo:onf-make library target help.
[HOWTO: Test]
o git clone ssh://gerrit.opencord.org:29418/voltha-docs.git
o cd voltha-docs
o git review -d Id0ae53f924f3cae6b2da1edc39c6aeb966cb6907
o make help-targets-main
o make help | grep Alias => Alias for git-submodules
o make git-submodules => (or make init)
Change-Id: Id0ae53f924f3cae6b2da1edc39c6aeb966cb6907
diff --git a/Makefile b/Makefile
index 4b22336..1648ba7 100644
--- a/Makefile
+++ b/Makefile
@@ -51,6 +51,12 @@
.PHONY: help test lint reload Makefile prep
## -----------------------------------------------------------------------
+## Intent: Display makefile target help
+## -----------------------------------------------------------------------
+help :: help-targets-main
+help-verbose :: help-targets-sphinx
+
+## -----------------------------------------------------------------------
## Intent: Real time viewing, dynamically generate and reload document
## changes for web browser viewing.
## Usage:
@@ -192,8 +198,9 @@
## -----------------------------------------------------------------------
## Intent: Display makefile target help
## -----------------------------------------------------------------------
-help :: $(venv-activate-patched)
+help-targets-sphinx : $(venv-activate-patched)
@ echo
+ @echo '[HELP: Sphinx]'
$(HIDE)$(activate) \
&& $(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -227,8 +234,37 @@
## -----------------------------------------------------------------------
## Intent:
## -----------------------------------------------------------------------
-help ::
- @echo " warnings Display WARNING strings buried in sphinx output"
+help :: help-targets-main
+help-targets-main :
+
+ @echo
+ @echo '[HELP]'
+ @printf ' %-30.30s %s\n' 'help' \
+ 'Summary makefile target help'
+ @printf ' %-30.30s %s\n' 'help-verbose' \
+ 'Extended makefile target help'
+
+ @echo
+ @echo '[INIT]'
+ @printf ' %-30.30s %s\n' 'init' \
+ 'Alias for git-submodules'
+ @printf ' %-30.30s %s\n' 'git-submodules' \
+ 'Checkout external dependent repositories'
+
+ @echo
+ @echo '[TEST: Failures]'
+ @printf ' %-30.30s %s\n' 'broken' \
+ 'Display broken URLs detected in linkcheck output'
+ @printf ' %-30.30s %s\n' 'warnings' \
+ 'Display WARNING strings buried in sphinx output'
+
+## -----------------------------------------------------------------------
+## Intent: Checkout external repository dependencies
+## -----------------------------------------------------------------------
+init :: git-submodules
+
+git-submodules:
+ git submodule update --init --recursive
## -----------------------------------------------------------------------
## Intent: Display make hel footer