kernel-doc: move kernel-doc tools to scripts/
tools/kernel-doc/docproc.c and tools/kernel-doc/kernel-doc are files imported from Linux Kernel. They originally resided under scripts/ directory in Linux Kernel. This commit moves them to the original location. Signed-off-by: Masahiro Yamada <yamada.m@jp.panasonic.com> Acked-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Masahiro Yamada
Tom Rini
parent
2c92b1d673
commit
8fac9c7b7d
10
Makefile
10
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: ;
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
#
|
||||
# Generated files
|
||||
#
|
||||
docproc
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
@ -18,4 +18,3 @@
|
|||
/easylogo/easylogo
|
||||
/gdb/gdbcont
|
||||
/gdb/gdbsend
|
||||
/kernel-doc/docproc
|
||||
|
|
|
|||
|
|
@ -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) > $@
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
Loading…
Reference in New Issue