From: Stefan Kangas <stefan@marxist.se>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 12411@debbugs.gnu.org, Bastien <bzg@altern.org>
Subject: bug#12411: 24.2.50; No `make help' target?
Date: Wed, 21 Aug 2019 01:09:32 +0200 [thread overview]
Message-ID: <CADwFkmmMqVC61q_QgRKNnBE2gZ4ujrmQb=8ZufsKFt+s46H6NQ@mail.gmail.com> (raw)
In-Reply-To: <87har5lyjz.fsf@altern.org>
[-- Attachment #1: Type: text/plain, Size: 750 bytes --]
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> sed -n 's/^\([a-z]*\):.*/\1/p' Makefile # plus uniq...
>> They are all pretty much standard targets, and documented at the top of
>> the Makefile.
>
> It's not always easy to find the doc corresponding to a given target, so
> I think it would indeed be a good idea to make "make help" return some
> useful info.
> I also think it would be a valuable addition to the GNU coding standards.
> Just like all commands should accept a "--help", it would make sense for
> the main Makefile to do something useful with "make help".
How about something like the attached patch?
I'm not a Makefile expert, so I couldn't find a way to skip the
configure step and immediately echo.
Thanks,
Stefan Kangas
[-- Attachment #2: 0001-Add-new-make-help-target.patch --]
[-- Type: text/x-patch, Size: 2317 bytes --]
From dc823516bc8085bfbab97d90395a33c884a24738 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Wed, 21 Aug 2019 01:02:43 +0200
Subject: [PATCH] Add new "make help" target
* Makefile.in: Add new "help" target with a brief summary of the
available targets. (Bug#12411)
* INSTALL: Announce it.
---
INSTALL | 3 +++
Makefile.in | 24 ++++++++++++++++++++++++
2 files changed, 27 insertions(+)
diff --git a/INSTALL b/INSTALL
index 6934022c4e..e9caff1501 100644
--- a/INSTALL
+++ b/INSTALL
@@ -109,6 +109,9 @@ sections if you need to.
(provided you have the 'gzip' program) those installed Lisp source (.el)
files that have corresponding .elc versions, as well as the Info files.
+ You can read a brief summary about other common make targets:
+
+ make help
ADDITIONAL DISTRIBUTION FILES
diff --git a/Makefile.in b/Makefile.in
index aa11e6b0b7..afdb86b518 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -1178,6 +1178,30 @@ check-declare:
$(MAKE) -C lisp $@
$(MAKE) -C test $@
+.PHONY: help
+
+help:
+ @echo ""
+ @echo "NOTE: This is a brief summary of some common make targets."
+ @echo "For more detailed information, please read the files INSTALL,"
+ @echo "INSTALL.REPO, Makefile or visit this URL:"
+ @echo "http://www.gnu.org/prep/standards/html_node/Standard-Targets.html"
+ @echo ""
+ @echo "make all -- compile and build Emacs"
+ @echo "make install -- install it"
+ @echo "make TAGS -- update tags tables"
+ @echo "make clean -- delete files from build"
+ @echo "make mostlyclean -- delete most files from build"
+ @echo "make distclean -- delete files from build and configure"
+ @echo "make maintainer-clean -- delete almost everything that can be regenerated"
+ @echo "make bootstrap -- delete all files and force a new bootstrap"
+ @echo "make uninstall -- delete all installed files"
+ @echo "make check -- run the Emacs test suite"
+ @echo "make docs -- generate Emacs documentation"
+ @echo "make html -- generate html documentation"
+ @echo "make ps -- generate ps documentation"
+ @echo "make pdf -- generate pdf documentation"
+
.PHONY: gitmerge
GITMERGE_EMACS = ./src/emacs${EXEEXT}
--
2.20.1
next prev parent reply other threads:[~2019-08-20 23:09 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-11 9:05 bug#12411: 24.2.50; No `make help' target? Bastien
2012-09-11 19:14 ` Glenn Morris
2012-09-11 20:34 ` Bastien
2012-09-12 7:52 ` Glenn Morris
2012-09-12 9:59 ` Bastien
2012-09-13 2:47 ` Glenn Morris
2012-09-13 12:43 ` Stefan Monnier
2012-09-13 3:23 ` Stefan Monnier
2019-08-20 23:09 ` Stefan Kangas [this message]
2019-08-21 16:57 ` Eli Zaretskii
2019-08-27 23:56 ` Stefan Kangas
2019-08-28 11:28 ` Eli Zaretskii
2019-08-29 10:01 ` Stefan Kangas
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='CADwFkmmMqVC61q_QgRKNnBE2gZ4ujrmQb=8ZufsKFt+s46H6NQ@mail.gmail.com' \
--to=stefan@marxist.se \
--cc=12411@debbugs.gnu.org \
--cc=bzg@altern.org \
--cc=monnier@iro.umontreal.ca \
/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.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.