summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile10
-rw-r--r--doc/DocBook/Makefile15
-rw-r--r--scripts/.gitignore4
-rw-r--r--scripts/Makefile14
-rw-r--r--scripts/docproc.c (renamed from tools/kernel-doc/docproc.c)2
-rwxr-xr-xscripts/kernel-doc (renamed from tools/kernel-doc/kernel-doc)0
-rw-r--r--tools/.gitignore1
-rw-r--r--tools/Makefile2
-rw-r--r--tools/kernel-doc/Makefile10
9 files changed, 32 insertions, 26 deletions
diff --git a/Makefile b/Makefile
index a3979ec..75fd7f3 100644
--- a/Makefile
+++ b/Makefile
@@ -1149,9 +1149,6 @@ $(TIMESTAMP_FILE):
env: depend scripts_basic
$(Q)$(MAKE) $(build)=tools/$@
-xmldocs pdfdocs psdocs htmldocs mandocs: tools/kernel-doc/docproc
- $(Q)$(MAKE) U_BOOT_VERSION=$(U_BOOT_VERSION) $(build)=doc/DocBook $@
-
tools-all: HOST_TOOLS_ALL=y
tools-all: env tools ;
@@ -1259,6 +1256,13 @@ backup:
F=`basename $(TOPDIR)` ; cd .. ; \
gtar --force-local -zcvf `LC_ALL=C date "+$$F-%Y-%m-%d-%T.tar.gz"` $$F
+
+# Documentation targets
+# ---------------------------------------------------------------------------
+%docs: scripts_basic FORCE
+ $(Q)$(MAKE) $(build)=scripts build_docproc
+ $(Q)$(MAKE) $(build)=doc/DocBook $@
+
# Dummies...
PHONY += prepare scripts
prepare: ;
diff --git a/doc/DocBook/Makefile b/doc/DocBook/Makefile
index 75e59c2..3077134 100644
--- a/doc/DocBook/Makefile
+++ b/doc/DocBook/Makefile
@@ -1,7 +1,7 @@
###
# This makefile is used to generate the kernel documentation,
# primarily based on in-line comments in various source files.
-# See doc/kernel-doc-nano-HOWTO.txt for instruction in how
+# See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how
# to document the SRC - and how to read it.
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.
@@ -51,8 +51,8 @@ installmandocs: mandocs
###
#External programs used
-KERNELDOC = $(srctree)/tools/kernel-doc/kernel-doc
-DOCPROC = $(objtree)/tools/kernel-doc/docproc
+KERNELDOC = $(srctree)/scripts/kernel-doc
+DOCPROC = $(objtree)/scripts/docproc
XMLTOFLAGS = -m $(srctree)/doc/DocBook/stylesheet.xsl
XMLTOFLAGS += --skip-validation
@@ -134,11 +134,8 @@ build_main_index = rm -rf $(main_idx); \
echo '<h2>U-Boot Version: $(U_BOOT_VERSION)</h2>' >> $(main_idx) && \
cat $(HTML) >> $(main_idx)
-# To work around bug [1] in docbook-xsl-stylesheets 1.76.1 , generate only html
-# docs instead of xhtml with xmlto.
-# [1] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=654338
quiet_cmd_db2html = HTML $@
- cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
+ cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
@@ -225,8 +222,8 @@ clean-files := $(DOCBOOKS) \
clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
cleandocs:
- @$(Q)rm -f $(call objectify, $(clean-files))
- @$(Q)rm -rf $(call objectify, $(clean-dirs))
+ $(Q)rm -f $(call objectify, $(clean-files))
+ $(Q)rm -rf $(call objectify, $(clean-dirs))
# Declare the contents of the .PHONY variable as phony. We keep that
# information in a variable se we can use it in if_changed and friends.
diff --git a/scripts/.gitignore b/scripts/.gitignore
new file mode 100644
index 0000000..82bc06e
--- /dev/null
+++ b/scripts/.gitignore
@@ -0,0 +1,4 @@
+#
+# Generated files
+#
+docproc
diff --git a/scripts/Makefile b/scripts/Makefile
index ebbadc9..242e3a0 100644
--- a/scripts/Makefile
+++ b/scripts/Makefile
@@ -1,2 +1,16 @@
+###
+# scripts contains sources for various helper programs used throughout
+# the kernel for the build process.
+# ---------------------------------------------------------------------------
+# docproc: Used in Documentation/DocBook
+
+# The following hostprogs-y programs are only build on demand
+hostprogs-y += docproc
+
+# These targets are used internally to avoid "is up to date" messages
+PHONY += build_docproc
+build_docproc: scripts/docproc
+ @:
+
# Let clean descend into subdirs
subdir- += basic
diff --git a/tools/kernel-doc/docproc.c b/scripts/docproc.c
index a9b49c5..23c3a43 100644
--- a/tools/kernel-doc/docproc.c
+++ b/scripts/docproc.c
@@ -65,7 +65,7 @@ FILELINE * docsection;
#define MAXLINESZ 2048
#define MAXFILES 250
-#define KERNELDOCPATH "tools/kernel-doc/"
+#define KERNELDOCPATH "scripts/"
#define KERNELDOC "kernel-doc"
#define DOCBOOK "-docbook"
#define LIST "-list"
diff --git a/tools/kernel-doc/kernel-doc b/scripts/kernel-doc
index cbbf34c..cbbf34c 100755
--- a/tools/kernel-doc/kernel-doc
+++ b/scripts/kernel-doc
diff --git a/tools/.gitignore b/tools/.gitignore
index 6e4a287..2a90dfe 100644
--- a/tools/.gitignore
+++ b/tools/.gitignore
@@ -18,4 +18,3 @@
/easylogo/easylogo
/gdb/gdbcont
/gdb/gdbsend
-/kernel-doc/docproc
diff --git a/tools/Makefile b/tools/Makefile
index 783e643..dcd49f8 100644
--- a/tools/Makefile
+++ b/tools/Makefile
@@ -183,8 +183,6 @@ HOST_EXTRACFLAGS += -include $(SRCTREE)/include/libfdt_env.h \
__build: $(LOGO-y)
-subdir-y += kernel-doc
-
$(LOGO_H): $(obj)/bmp_logo $(LOGO_BMP)
$(obj)/bmp_logo --gen-info $(LOGO_BMP) > $@
diff --git a/tools/kernel-doc/Makefile b/tools/kernel-doc/Makefile
deleted file mode 100644
index f15a4b7..0000000
--- a/tools/kernel-doc/Makefile
+++ /dev/null
@@ -1,10 +0,0 @@
-#
-# Copyright (C) 2012 Marek Vasut <marex@denx.de>
-#
-# SPDX-License-Identifier: GPL-2.0+
-#
-
-hostprogs-y := docproc
-always := $(hostprogs-y)
-
-HOST_EXTRACFLAGS := -pedantic