[PATCH] Makefile: Add help target
- From
Stephen Boyd <bebarino@gmail.com>
- Date
- Sep 28, 2010, 08:13 UTC
- Message-ID
- <1285661638-27741-1-git-send-email-bebarino@gmail.com>
Today I forgot whether the target was quick-install-doc or install-quick-doc and had to open the Makefile again to find out. I'd rather not do that and just use:
$ make help
to get a quick summary of the interesting targets when my brain fails to refresh. Add a help target, but don't add uninteresting things like strip, install-gitweb, or targets which alias (install-man).
Signed-off-by: Stephen Boyd <bebarino@gmail.com> --- Makefile | 40 ++++++++++++++++++++++++++++++++++++++++ 1 files changed, 40 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile index b7a62cf..8c8fcb0 100644 --- a/Makefile +++ b/Makefile @@ -2366,3 +2366,43 @@ cover_db: coverage-report cover_db_html: cover_db cover -report html -outputdir cover_db_html cover_db + +help: + @echo 'Cleaning targets:' + @echo ' clean - Remove generated files but keep the configure script' + @echo ' distclean - Remove generated files and the configure script' + @echo + @echo 'Packaging targets:' + @echo ' dist - Build git-$(GIT_VERSION).tar.gz source tarball' + @echo ' rpm - Build source and binary RPM packages' + @echo ' dist-doc - Build $(manpages).tar.gz and $(htmldocs).tar.gz' + @echo + @echo 'Documentation targets:' + @echo ' doc - Build man pages and HTML docs' + @echo ' man - Build man pages' + @echo ' html - Build HTML docs' + @echo ' info - Build info docs' + @echo ' pdf - Build PDF docs' + @echo + @echo 'Installation targets:' + @echo ' install - Install the git suite' + @echo ' install-doc - Install man pages' + @echo ' install-html - Install HTML docs' + @echo ' install-info - Install info docs' + @echo ' install-pdf - Install PDF docs' + @echo ' quick-install-doc - Install pregenerated man pages from origin/man' + @echo ' quick-install-html - Install pregenerated HTML pages from origin/html' + @echo + @echo 'Common targets:' + @echo ' all - Build the git suite' + @echo ' test - Run the git test suite' + @echo + @echo 'Other targets:' + @echo ' tags/TAGS - Generate tags for editors' + @echo ' cscope - Generate cscope index' + @echo ' coverage - Build git with gcov support and run the test suite' + @echo ' cover_db_html - Generate HTML coverage report of the test suite coverage' + @echo ' check - Check C sources with sparse' + @echo + @echo ' make V=1 [targets] verbose build' + @echo
-- 1.7.3.16.g5d4d9