diff mbox series

Makefile: Add top level doc target

Message ID 20180319021227.14160-1-joel@jms.id.au
State Superseded
Headers show
Series Makefile: Add top level doc target | expand

Commit Message

Joel Stanley March 19, 2018, 2:12 a.m. UTC
It's not clear what a 'make doc' should do at the top level given the
number of doc targets we have. Instead give the user the hint that they
should go into the doc directory.

Signed-off-by: Joel Stanley <joel@jms.id.au>
---
 Makefile.main | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Stewart Smith March 20, 2018, 6:10 p.m. UTC | #1
Joel Stanley <joel@jms.id.au> writes:
> It's not clear what a 'make doc' should do at the top level given the
> number of doc targets we have. Instead give the user the hint that they
> should go into the doc directory.

I'd advocate for doing a 'make html' as that's probably the most typical
thing that anybody is going to do...
diff mbox series

Patch

diff --git a/Makefile.main b/Makefile.main
index 96836384aba8..3fd5c3b7b67f 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:
+	@echo "Please enter the doc/ directory and try again"
+
 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