# [PATCH/RFC] Makefile: add 'help' target for target summary

2 messages from 2011-12-13 to 2011-12-13. Participants: Nguyễn Thái Ngọc Duy, Jakub Narebski.
Thread: https://gitlist.dev/t/29147

## Nguyễn Thái Ngọc Duy, 2011-12-13 13:16

Subject: [PATCH/RFC] Makefile: add 'help' target for target summary
Message-ID: <1323782164-11759-1-git-send-email-pclouds@gmail.com>
URL: https://gitlist.dev/e/1323782164-11759-1-git-send-email-pclouds%40gmail.com

```
I find this "make help" very helpful (at work, on a different
project). With this I don't have to crawl through Makefile when I need
something but cannot remember what's the target name. It should also
help discover new targets.

We may also have "make vars" (or something like that) that shows list
of user-configurable variables, basically a conversion of the big
comment block near the makefile's top into a printable target.

I don't work with this Makefile much, so this is just an idea. Anyone
up to turn it to something actually useful?

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 Makefile |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/Makefile b/Makefile
index ed82320..abf6cf9 100644
--- a/Makefile
+++ b/Makefile
@@ -2603,3 +2603,17 @@ profile-all: profile-clean
 	$(MAKE) CFLAGS="$(PROFILE_GEN_CFLAGS)" all
 	$(MAKE) CFLAGS="$(PROFILE_GEN_CFLAGS)" -j1 test
 	$(MAKE) CFLAGS="$(PROFILE_USE_CFLAGS)" all
+
+.PHONY: help
+
+help:
+	@echo "test		Run the test suite"
+	@echo "coverage	Build git with coverage support"
+	@echo "cover_db	Generate coverage database from *.gcov"
+	@echo "cover_db_html	Generate coverage report"
+	@echo "profile-all	Build git with profiling support"
+	@echo "clean		Clean intermediate files"
+	@echo "distclean	Clean even more for dist packaging"
+	@echo "sparse		Run git with sparse"
+	@echo "cscope		Generate cscope symbol database"
+	@echo "check-docs	Check documentation"
-- 
1.7.8.36.g69ee2

```

## Jakub Narebski, 2011-12-13 15:00

Subject: Re: [PATCH/RFC] Makefile: add 'help' target for target summary
Message-ID: <m3aa6wh5xu.fsf@localhost.localdomain>
URL: https://gitlist.dev/e/m3aa6wh5xu.fsf%40localhost.localdomain
In-Reply-To: <1323782164-11759-1-git-send-email-pclouds@gmail.com>

```
乧畹﻿ễ渠周﻿á椠乧﻿ọ挠䑵礠‼灣汯畤獀杭慩氮捯派⁷物瑥猺ਊ㸠䤠晩湤⁴桩猠≭慫攠桥汰∠癥特⁨敬灦畬 慴⁷潲欬⁯渠愠摩晦敲敮琊㸠灲潪散琩⸠坩瑨⁴桩猠䤠摯渧琠桡癥⁴漠捲慷氠瑨牯畧栠䵡步晩汥⁷桥渠䤠湥敤ਾ⁳潭整桩湧⁢畴⁣慮湯琠牥浥浢敲⁷桡琧猠瑨攠瑡牧整⁮慭攮⁉琠獨潵汤⁡汳漊㸠桥汰⁤楳捯癥爠湥眠瑡牧整献ਾ 㸠坥⁭慹⁡汳漠桡癥•浡步⁶慲猢 潲⁳潭整桩湧⁬楫攠瑨慴⤠瑨慴⁳桯睳⁬楳琊㸠潦⁵獥爭捯湦楧畲慢汥⁶慲楡扬敳Ⱐ扡獩捡汬礠愠捯湶敲獩潮⁯映瑨攠扩朊㸠捯浭敮琠扬潣欠湥慲⁴桥⁭慫敦楬攧猠瑯瀠楮瑯⁡⁰物湴慢汥⁴慲来琮ਾ 㸠䤠摯渧琠睯牫⁷楴栠瑨楳⁍慫敦楬攠浵捨Ⱐ獯⁴桩猠楳⁪畳琠慮⁩摥愮⁁湹潮攊㸠異⁴漠瑵牮⁩琠瑯⁳潭整桩湧⁡捴畡汬礠畳敦畬㼊੓桯畬搠瑨楳⁢攠楮⁣潭浩琠浥獳慧攬⁯爠楮⁣潭浥湴猠⡢敬潷•ⴭⵜ渢⤿ਊ乢⸠瑨敲攠睡猠慴⁬敡獴⁯湥⁡瑴敭灴⁴漠慤搠≭慫攠桥汰∠畳楮朊楮ⵍ慫敦楬攠彡湮潴慴楯湳弬⁳漠瑨慴•浡步⁨敬瀢⁷潵汤渧琠来琠扡摬礠潵琊潦⁳祮挮⸮ਊ㸠卩杮敤ⵯ晦ⵢ示⁎杵秾＞앮⁔棾＀⁎柾＞쵣⁄畹‼灣汯畤獀杭慩氮捯派ਾ‭ⴭਾ†䵡步晩汥⁼†‱㐠⬫⬫⬫⬫⬫⬫⬫ਾ†ㄠ晩汥猠捨慮来搬‱㐠楮獥牴楯湳⠫⤬‰⁤敬整楯湳⠭⤊㸠ਾ⁤楦映ⴭ杩琠愯䵡步晩汥⁢⽍慫敦楬攊㸠楮摥砠敤㠲㌲〮⹡扦㙣昹‱〰㘴㐊㸠ⴭⴠ愯䵡步晩汥ਾ‫⬫⁢⽍慫敦楬攊㸠䁀‭㈶〳ⰳ‫㈶〳ⰱ㜠䁀⁰牯晩汥ⵡ汬㨠灲潦楬攭捬敡渊㸠 ␨䵁䭅⤠䍆䱁䝓㴢␨偒但䥌䕟䝅也䍆䱁䝓⤢⁡汬ਾ†त⡍䅋䔩⁃䙌䅇匽∤⡐剏䙉䱅彇䕎彃䙌䅇匩∠⵪ㄠ瑥獴ਾ†त⡍䅋䔩⁃䙌䅇匽∤⡐剏䙉䱅录卅彃䙌䅇匩∠慬氊㸠⬊㸠⬮偈低夺⁨敬瀊㸠⬊㸠⭨敬瀺ਾ‫ी散桯•瑥獴उ創渠瑨攠瑥獴⁳畩瑥∊㸠⬉䁥捨漠≣潶敲慧攉䉵楬搠杩琠睩瑨⁣潶敲慧攠獵灰潲琢ਾ‫ी散桯•捯癥牟摢े敮敲慴攠捯癥牡来⁤慴慢慳攠晲潭‪⹧捯瘢ਾ‫ी散桯•捯癥牟摢彨瑭氉䝥湥牡瑥⁣潶敲慧攠牥灯牴∊㸠⬉䁥捨漠≰牯晩汥ⵡ汬ू畩汤⁧楴⁷楴栠灲潦楬楮朠獵灰潲琢ਾ‫ी散桯•捬敡渉ृ汥慮⁩湴敲浥摩慴攠晩汥猢ਾ‫ी散桯•摩獴捬敡渉䍬敡渠敶敮⁭潲攠景爠摩獴⁰慣歡杩湧∊㸠⬉䁥捨漠≳灡牳攉॒畮⁧楴⁷楴栠獰慲獥∊㸠⬉䁥捨漠≣獣潰攉े敮敲慴攠捳捯灥⁳祭扯氠摡瑡扡獥∊㸠⬉䁥捨漠≣桥捫ⵤ潣猉䍨散欠摯捵浥湴慴楯渢ਾ‭ⴠਾ‱⸷⸸⸳㘮朶㥥攲ਾ ਭⴠ੊慫畢⁎慲﻿ę扳歩�
```
