git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Stephen Boyd <bebarino@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Makefile: Add help target
Date: Tue, 28 Sep 2010 01:13:58 -0700	[thread overview]
Message-ID: <1285661638-27741-1-git-send-email-bebarino@gmail.com> (raw)

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

             reply	other threads:[~2010-09-28  8:14 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-09-28  8:13 Stephen Boyd [this message]
2010-09-28  9:45 ` [PATCH] Makefile: Add help target Junio C Hamano
2010-09-28 11:37   ` Sverre Rabbelier
2010-09-28 12:35     ` Andreas Ericsson
2010-09-28 14:44       ` [PATCH] Makefile: implement " Michael J Gruber
2010-09-28 14:48         ` Sverre Rabbelier
2010-09-28 14:57           ` Zbyszek Szmek
2010-09-28 14:54         ` Ævar Arnfjörð Bjarmason
2010-09-28 15:33         ` Junio C Hamano
2010-09-28 15:47           ` Michael J Gruber
2010-09-28 16:04             ` Ævar Arnfjörð Bjarmason
2010-09-28 20:38               ` [PATCHv2] " Michael J Gruber
2010-09-28 20:51                 ` Sverre Rabbelier
2010-09-28 21:24                 ` Jakub Narebski
2010-09-28 22:00                 ` Brandon Casey
2010-09-29  8:06                   ` Michael J Gruber
2010-09-29  5:16                 ` Jeff King
2010-09-29  7:03                   ` Michael J Gruber
2010-09-29  7:34                     ` Jeff King
2010-09-29 15:41                       ` Junio C Hamano
2010-09-29 20:15                         ` [PATCHv3] " Michael J Gruber
2010-09-29 20:39                           ` Junio C Hamano
2010-09-30  7:08                             ` Michael J Gruber
2010-09-29  6:10   ` [PATCH] Makefile: Add " yj2133011
  -- strict thread matches above, loose matches on Subject: below --
2022-04-08  7:45 [PATCH] Makefile: add " Elia Pinto
2022-04-08  9:32 ` Philip Oakley
2022-04-08 15:30 ` Taylor Blau
2022-04-08 15:44   ` Ævar Arnfjörð Bjarmason
2022-04-08 18:58   ` Junio C Hamano
2010-08-25  9:51 [PATCH] Makefile: Add " Stephen Boyd
2010-08-25 16:27 ` Sverre Rabbelier
2010-08-25 21:36   ` Stephen Boyd
2010-08-25 21:39     ` Sverre Rabbelier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1285661638-27741-1-git-send-email-bebarino@gmail.com \
    --to=bebarino@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).