From: Jani Nikula <jani.nikula@intel.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Jani Nikula <jani.nikula@intel.com>,
Daniel Vetter <daniel.vetter@ffwll.ch>
Subject: [RFC 07/10] scripts: add tool for generating asciidoc dependencies and rules
Date: Tue, 26 Jan 2016 14:08:52 +0200 [thread overview]
Message-ID: <05a5bccbc72f5e7a2fc1ba018c507e3fb56a779b.1453809420.git.jani.nikula@intel.com> (raw)
In-Reply-To: <cover.1453809420.git.jani.nikula@intel.com>
In-Reply-To: <cover.1453809420.git.jani.nikula@intel.com>
Given a list of special format filenames, generate dependencies and
rules for kernel-doc invocation on those files, to be included in to
Makefiles.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
scripts/kernel-doc-deps | 66 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 66 insertions(+)
create mode 100755 scripts/kernel-doc-deps
diff --git a/scripts/kernel-doc-deps b/scripts/kernel-doc-deps
new file mode 100755
index 000000000000..c348863b9354
--- /dev/null
+++ b/scripts/kernel-doc-deps
@@ -0,0 +1,66 @@
+#!/bin/bash
+
+SRCTREE=
+DSTTREE=
+DEP=
+KERNELDOC=
+TOOL=kernel-doc-helper
+
+while getopts "k:t:s:d:m:" opt; do
+ case "$opt" in
+ k)
+ KERNELDOC="$OPTARG"
+ ;;
+ t)
+ TOOL="$OPTARG"
+ ;;
+ s)
+ SRCTREE="$OPTARG/"
+ ;;
+ d)
+ DSTTREE="$OPTARG/"
+ ;;
+ m)
+ DEP="$OPTARG"
+ ;;
+ *)
+ echo "fail"
+ exit 1
+ esac
+done
+shift `expr $OPTIND - 1`
+
+ACTION="\tmkdir \$()\n\t${TOOL} -w \$@ \$^ > \$@"
+
+# $1 = filename
+# $2 = for what type
+print_rule()
+{
+ echo "$1: $2"
+ echo -e "\tmkdir -p \$(dir \$@)"
+ echo -e "\t${TOOL} -k ${KERNELDOC} -w \$@ \$^ > \$@"
+ echo "$DEP: $1"
+}
+
+# given a list of filenames with special notation, generate deps
+
+while read file; do
+ case $file in
+ # all of these are C/H source files
+ *,export)
+ print_rule "${DSTTREE}$file" "${SRCTREE}${file%,export}"
+ ;;
+ *,internal)
+ print_rule "${DSTTREE}$file" "${SRCTREE}${file%,internal}"
+ ;;
+ *,function,*)
+ print_rule "${DSTTREE}$file" "${SRCTREE}${file%,function,*}"
+ ;;
+ *,doc,*)
+ print_rule "${DSTTREE}$file" "${SRCTREE}${file%,doc,*}"
+ ;;
+ *)
+ print_rule "${DSTTREE}/${file%,txt,} " "${SRCTREE}${file%,F,*}"
+ ;;
+ esac
+done
--
2.1.4
next prev parent reply other threads:[~2016-01-26 12:11 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-01-25 23:28 [RFC] A first shot at asciidoc-based formatted docs Jonathan Corbet
2016-01-25 23:28 ` [PATCH 1/4] kernel-doc: add support for asciidoc output Jonathan Corbet
2016-01-25 23:28 ` [PATCH 2/4] docproc: handle asciidoc templates Jonathan Corbet
2016-01-25 23:28 ` [PATCH 3/4] Docs: Makefile tweaks for " Jonathan Corbet
2016-01-25 23:28 ` [PATCH 4/4] Docs: add a sample asciidoc template Jonathan Corbet
2016-01-26 12:08 ` [RFC] A first shot at asciidoc-based formatted docs Jani Nikula
2016-01-26 12:08 ` [RFC 01/10] kernel-doc: rewrite usage description, remove duplicated comments Jani Nikula
2016-01-26 12:08 ` [RFC 02/10] kernel-doc: add support for asciidoc output Jani Nikula
2016-01-26 12:08 ` [RFC 03/10] kernel-doc: support printing exported and non-exported symbols Jani Nikula
2016-01-26 12:08 ` [RFC 04/10] kernel-doc: add support for printing DOC: comments with escaped names Jani Nikula
2016-01-26 12:08 ` [RFC 05/10] scripts: add asciidoc-includes to extract includes from asciidoc Jani Nikula
2016-01-26 12:08 ` [RFC 06/10] scripts: add a kernel-doc helper for special invocation Jani Nikula
2016-01-26 12:08 ` Jani Nikula [this message]
2016-01-26 12:08 ` [RFC 08/10] scripts: add a crude converter from DocBook tmpl to asciidoc Jani Nikula
2016-01-26 12:08 ` [RFC 09/10] Documentation: convert gpu.tmpl to gpu.txt Jani Nikula
2016-01-26 12:08 ` [RFC 10/10] Documentation: build asciidoc documentation Jani Nikula
2016-01-26 12:17 ` [RFC] A first shot at asciidoc-based formatted docs Daniel Vetter
2016-01-26 12:38 ` Jani Nikula
2016-01-26 14:48 ` Jonathan Corbet
2016-01-26 14:52 ` Jonathan Corbet
2016-02-10 0:09 ` Jonathan Corbet
2016-02-10 8:07 ` Daniel Vetter
2016-02-10 14:03 ` Jani Nikula
2016-02-10 16:12 ` Jani Nikula
2016-02-10 20:56 ` Jonathan Corbet
2016-02-11 15:18 ` Keith Packard
2016-02-10 20:45 ` Jonathan Corbet
2016-02-10 23:01 ` Keith Packard
2016-02-11 13:44 ` Jani Nikula
2016-02-11 15:21 ` Keith Packard
2016-02-13 3:20 ` Keith Packard
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=05a5bccbc72f5e7a2fc1ba018c507e3fb56a779b.1453809420.git.jani.nikula@intel.com \
--to=jani.nikula@intel.com \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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
all inboxes | Powered by JetHome®