{"thread":{"id":"24856","subject":"[PATCH] Makefile: Add help target","startedAt":"2010-08-25T09:51:53Z","lastAt":"2010-08-25T21:39:49Z","messageCount":4,"participants":["Stephen Boyd","Sverre Rabbelier"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"148960","messageId":"1282729913-25114-1-git-send-email-bebarino@gmail.com","threadId":"24856","inReplyTo":null,"subject":"[PATCH] Makefile: Add help target","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2010-08-25T09:51:53Z","receivedAt":"2010-08-25T09:51:53Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Today I forgot whether the target was quick-install-doc or\ninstall-quick-doc and had to open the Makefile again to find out. I'd\nrather not do that and just use:\n\n\t$ make help\n\nto get a quick summary of the interesting targets when my brain fails to\nrefresh. Add a help target, but don't add uninteresting things like\nstrip, install-gitweb, or targets which alias (install-man).\n\nSigned-off-by: Stephen Boyd \n---\n\nSome things I noticed:\n\n * make V=0 is verbose\n\n * sparse checking looks broken for the builtin/ directory structure\n\n * t/Makefile has a target for valgrind, but the toplevel makefile doesn't\n\n * 'make tags/TAGS/cscope' is always verbose\n\n * I stay up late on Tuesdays\n\n Makefile | 40 ++++++++++++++++++++++++++++++++++++++++\n 1 files changed, 40 insertions(+), 0 deletions(-)\n\ndiff --git a/Makefile b/Makefile\nindex b4745a5..8c90c33 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -2307,3 +2307,43 @@ coverage-report:\n \tgrep '^function.*called 0 ' *.c.gcov \\\n \t\t| sed -e 's/\\([^:]*\\)\\.gcov: *function \\([^ ]*\\) called.*/\\1: \\2/' \\\n \t\t| tee coverage-untested-functions\n+\n+help:\n+\t@echo 'Cleaning targets:'\n+\t@echo ' clean - Remove generated files but keep the configure script'\n+\t@echo ' distclean - Remove generated files and the configure script'\n+\t@echo\n+\t@echo 'Packaging targets:'\n+\t@echo ' dist - Build git-$(GIT_VERSION).tar.gz source tarball'\n+\t@echo ' rpm - Build source and binary RPM packages'\n+\t@echo ' dist-doc - Build $(manpages).tar.gz and $(htmldocs).tar.gz'\n+\t@echo\n+\t@echo 'Documentation targets:'\n+\t@echo ' doc - Build man pages and HTML docs'\n+\t@echo ' man - Build man pages'\n+\t@echo ' html - Build HTML docs'\n+\t@echo ' info - Build info docs'\n+\t@echo ' pdf - Build PDF docs'\n+\t@echo\n+\t@echo 'Installation targets:'\n+\t@echo ' install - Install the git suite'\n+\t@echo ' install-doc - Install man pages'\n+\t@echo ' install-html - Install HTML docs'\n+\t@echo ' install-info - Install info docs'\n+\t@echo ' install-pdf - Install PDF docs'\n+\t@echo ' quick-install-doc - Install pregenerated man pages from origin/man'\n+\t@echo ' quick-install-html - Install pregenerated HTML pages from origin/html'\n+\t@echo\n+\t@echo 'Common targets:'\n+\t@echo ' all - Build the git suite'\n+\t@echo ' test - Run the git test suite'\n+\t@echo\n+\t@echo 'Other targets:'\n+\t@echo ' tags/TAGS - Generate tags for editors'\n+\t@echo ' cscope - Generate cscope index'\n+\t@echo ' coverage - Build git with gcov support, run the test suite, and'\n+\t@echo ' report untested functions'\n+\t@echo ' check - Check C sources with sparse'\n+\t@echo\n+\t@echo ' make V=1 [targets] verbose build'\n+\t@echo\n-- \n1.7.2.2.169.gb5442\n"},{"id":"148972","messageId":"AANLkTi=+f4Q6JJHfX75A57-gzBxqsdr+CrCf9Z9fqrEq@mail.gmail.com","threadId":"24856","inReplyTo":"1282729913-25114-1-git-send-email-bebarino@gmail.com","subject":"Re: [PATCH] Makefile: Add help target","fromName":"Sverre Rabbelier","fromEmail":"srabbelier@gmail.com","sentAt":"2010-08-25T16:27:48Z","receivedAt":"2010-08-25T16:27:48Z","isPatch":true,"sender":{"key":"srabbelier@gmail.com","avatar":"https://avatars.githubusercontent.com/u/3098?v=4"},"body":"Heya,\n\nOn Wed, Aug 25, 2010 at 04:51, Stephen Boyd wrote:\n> Today I forgot whether the target was quick-install-doc or\n> install-quick-doc and had to open the Makefile again to find out. I'd\n> rather not do that and just use:\n>\n>        $ make help\n>\n> to get a quick summary of the interesting targets when my brain fails to\n> refresh. Add a help target, but don't add uninteresting things like\n> strip, install-gitweb, or targets which alias (install-man).\n\nYes please, it would be even better if you're willing to make sure\nthat this stays up to date ;).\n\n-- \nCheers,\n\nSverre Rabbelier\n"},{"id":"149002","messageId":"AANLkTimSP=4bMwN_DAuDoaG5mGACYJYp2TTyDKSFY5BF@mail.gmail.com","threadId":"24856","inReplyTo":"AANLkTi=+f4Q6JJHfX75A57-gzBxqsdr+CrCf9Z9fqrEq@mail.gmail.com","subject":"Re: [PATCH] Makefile: Add help target","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2010-08-25T21:36:49Z","receivedAt":"2010-08-25T21:36:49Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Hey Sverre,\n\nOn Wed, Aug 25, 2010 at 9:27 AM, Sverre Rabbelier wrote:\n> Heya,\n>\n> On Wed, Aug 25, 2010 at 04:51, Stephen Boyd wrote:\n>> Today I forgot whether the target was quick-install-doc or\n>> install-quick-doc and had to open the Makefile again to find out. I'd\n>> rather not do that and just use:\n>>\n>>        $ make help\n>>\n>> to get a quick summary of the interesting targets when my brain fails to\n>> refresh. Add a help target, but don't add uninteresting things like\n>> strip, install-gitweb, or targets which alias (install-man).\n>\n> Yes please, it would be even better if you're willing to make sure\n> that this stays up to date ;).\n>\n\n\"Yes please\" means you like it?\n\nI'll keep an eye on the list for any interesting Makefile targets, but\nno promises ;-)\n"},{"id":"149003","messageId":"AANLkTimA5YWANGRE19psyuunYLiskSoEunQmsY1UNtyc@mail.gmail.com","threadId":"24856","inReplyTo":"AANLkTimSP=4bMwN_DAuDoaG5mGACYJYp2TTyDKSFY5BF@mail.gmail.com","subject":"Re: [PATCH] Makefile: Add help target","fromName":"Sverre Rabbelier","fromEmail":"srabbelier@gmail.com","sentAt":"2010-08-25T21:39:49Z","receivedAt":"2010-08-25T21:39:49Z","isPatch":true,"sender":{"key":"srabbelier@gmail.com","avatar":"https://avatars.githubusercontent.com/u/3098?v=4"},"body":"Heya,\n\nOn Wed, Aug 25, 2010 at 16:36, Stephen Boyd wrote:\n> \"Yes please\" means you like it?\n\nIndeed.\n\n> I'll keep an eye on the list for any interesting Makefile targets, but\n> no promises ;-)\n\nThat's all we can ask for right :).\n\n-- \nCheers,\n\nSverre Rabbelier\n"}]}