DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH 3/3] mk: rule help
Date: Tue,  7 May 2013 17:17:15 +0200	[thread overview]
Message-ID: <f54b18b23b958789d69e7d5d1376cec813093f9d.1367939814.git.thomas.monjalon@6wind.com> (raw)
In-Reply-To: <cover.1367939814.git.thomas.monjalon@6wind.com>
In-Reply-To: <cover.1367939814.git.thomas.monjalon@6wind.com>

The goal of this rule is to show which rules/options are available from a
"make" command.
Let's start by printing short doc about SDK building.

The macro maketxt allow to interpret syntax "# make foo" while keeping
indentation of the source document.
Here, it is used to call "make showconfigs" to list available targets.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 mk/rte.sdkdoc.mk  |    8 ++++++++
 mk/rte.sdkroot.mk |    3 ++-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index edae1e7..6850c39 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -38,6 +38,14 @@ $(error "Cannot use T= with doc target")
 endif
 endif
 
+define maketxt
+	sed 's,^\([[:space:]]*\)# make \(.*\),make -rRs \2 | sed "s/^/\1/",e' $1
+endef
+
+.PHONY: help
+help:
+	@$(call maketxt, $(RTE_SDK)/doc/build-sdk-quick.txt)
+
 .PHONY: all
 all: htmlapi
 
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index 6bbbd54..905b678 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -103,8 +103,9 @@ testall testimport:
 install uninstall:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@
 
-.PHONY: doc
+.PHONY: doc help
 doc: doc-all
+help: doc-help
 doc-%:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $*
 
-- 
1.7.10.4

  parent reply	other threads:[~2013-05-07 15:17 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-05-07 15:17 [dpdk-dev] [PATCH 0/3] make help Thomas Monjalon
2013-05-07 15:17 ` [dpdk-dev] [PATCH 1/3] mk: rule showconfigs for configs listing Thomas Monjalon
2013-05-17  9:05   ` Olivier MATZ
2013-05-17 14:53     ` Thomas Monjalon
2013-05-07 15:17 ` [dpdk-dev] [PATCH 2/3] doc: how to build Thomas Monjalon
2013-05-17  9:06   ` Olivier MATZ
2013-05-17 15:20     ` Thomas Monjalon
2013-05-07 15:17 ` Thomas Monjalon [this message]
2013-05-17  9:06   ` [dpdk-dev] [PATCH 3/3] mk: rule help Olivier MATZ
2013-05-17 15:27     ` Thomas Monjalon
2013-05-28 22:15 ` [dpdk-dev] [PATCH v2 0/3] make help Thomas Monjalon
2013-05-28 22:15   ` [dpdk-dev] [PATCH v2 1/3] doc: how to build Thomas Monjalon
2013-05-28 22:15   ` [dpdk-dev] [PATCH v2 2/3] mk: rule showconfigs for configs listing Thomas Monjalon
2013-05-28 22:15   ` [dpdk-dev] [PATCH v2 3/3] mk: rule help Thomas Monjalon
2013-05-30 14:55   ` [dpdk-dev] [PATCH v2 0/3] make help Olivier MATZ
2013-05-30 22:02     ` Thomas Monjalon

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=f54b18b23b958789d69e7d5d1376cec813093f9d.1367939814.git.thomas.monjalon@6wind.com \
    --to=thomas.monjalon@6wind.com \
    --cc=dev@dpdk.org \
    /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).