diff mbox series

[v2] Makefile: Make it easier to find the docs

Message ID 20180410063830.27939-1-joel@jms.id.au
State Accepted
Headers show
Series [v2] Makefile: Make it easier to find the docs | expand

Commit Message

Joel Stanley April 10, 2018, 6:38 a.m. UTC
Ad a top level 'doc' target that builds the html docs when the user
types 'make doc'. Users who want other targets know that the docs live
under docs/, so can go looking there.

Signed-off-by: Joel Stanley <joel@jms.id.au>
---
v2: build the html target as this is what most users want
---
 Makefile.main | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Stewart Smith April 12, 2018, 6:14 a.m. UTC | #1
Joel Stanley <joel@jms.id.au> writes:
> Ad a top level 'doc' target that builds the html docs when the user
> types 'make doc'. Users who want other targets know that the docs live
> under docs/, so can go looking there.
>
> Signed-off-by: Joel Stanley <joel@jms.id.au>
> ---
> v2: build the html target as this is what most users want
> ---
>  Makefile.main | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)

Thanks! Merged to master as of 379ec78e3da982cd1dff1533d50a9b29b025db5b
diff mbox series

Patch

diff --git a/Makefile.main b/Makefile.main
index 96836384aba8..584d46df3758 100644
--- a/Makefile.main
+++ b/Makefile.main
@@ -290,13 +290,16 @@  skiboot.info: coverage external/pflash/pflash.info external/gard/gard.info
 	lcov -q -a $@ -a external/gard/gard.info -o $@
 	lcov -q -r $@ $(LCOV_EXCLUDE) -o $@ --rc lcov_branch_coverage=1
 
+doc:
+	make -C doc html
+
 tags:
 	find . -name '*.[chS]' | xargs ctags
 
 TAGS:
 	find . -name '*.[chS]' | xargs etags
 
-.PHONY: tags TAGS check coverage
+.PHONY: tags TAGS check coverage doc
 
 cscope:
 	find . -name '*.[chS]' | xargs cscope