doc: Remove duplicated documentation directory

Commit ad7061ed74 ("doc: Move device tree bindings documentation to
 doc/device-tree-bindings") moved all device tree binding documentation
to doc/device-tree-bindings directory.

The current U-Boot project still have two documentation directories:

- doc/
- Documentation/

Move all documentation and sphinx files to doc directory so all content
can be in a common place.

Signed-off-by: Breno Lima <breno.lima@nxp.com>
This commit is contained in:
Breno Matheus Lima 2019-06-05 18:18:30 +00:00 committed by Tom Rini
parent 894e235f14
commit 656d8da9d2
32 changed files with 13 additions and 13 deletions

View File

@ -476,7 +476,7 @@ S: Maintained
T: git https://gitlab.denx.de/u-boot/custodians/u-boot-efi.git T: git https://gitlab.denx.de/u-boot/custodians/u-boot-efi.git
F: doc/README.uefi F: doc/README.uefi
F: doc/README.iscsi F: doc/README.iscsi
F: Documentation/efi.rst F: doc/efi.rst
F: include/capitalization.h F: include/capitalization.h
F: include/charset.h F: include/charset.h
F: include/cp1250.h F: include/cp1250.h

View File

@ -168,7 +168,7 @@ MAKEFLAGS += --no-print-directory
# Use 'make C=2' to enable checking of *all* source files, regardless # Use 'make C=2' to enable checking of *all* source files, regardless
# of whether they are re-compiled or not. # of whether they are re-compiled or not.
# #
# See the file "Documentation/sparse.txt" for more details, including # See the file "doc/sparse.txt" for more details, including
# where to get the "sparse" utility. # where to get the "sparse" utility.
ifeq ("$(origin C)", "command line") ifeq ("$(origin C)", "command line")
@ -1916,7 +1916,7 @@ help:
@echo ' coccicheck - Execute static code analysis with Coccinelle' @echo ' coccicheck - Execute static code analysis with Coccinelle'
@echo '' @echo ''
@echo 'Documentation targets:' @echo 'Documentation targets:'
@$(MAKE) -f $(srctree)/Documentation/Makefile dochelp @$(MAKE) -f $(srctree)/doc/Makefile dochelp
@echo '' @echo ''
@echo ' make V=0|1 [targets] 0 => quiet build (default), 1 => verbose build' @echo ' make V=0|1 [targets] 0 => quiet build (default), 1 => verbose build'
@echo ' make V=2 [targets] 2 => give reason for rebuild of target' @echo ' make V=2 [targets] 2 => give reason for rebuild of target'
@ -1945,7 +1945,7 @@ DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs \
linkcheckdocs dochelp refcheckdocs linkcheckdocs dochelp refcheckdocs
PHONY += $(DOC_TARGETS) PHONY += $(DOC_TARGETS)
$(DOC_TARGETS): scripts_basic FORCE $(DOC_TARGETS): scripts_basic FORCE
$(Q)$(MAKE) $(build)=Documentation $@ $(Q)$(MAKE) $(build)=doc $@
endif #ifeq ($(config-targets),1) endif #ifeq ($(config-targets),1)
endif #ifeq ($(mixed-targets),1) endif #ifeq ($(mixed-targets),1)

View File

@ -8,7 +8,7 @@ subdir-y :=
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
SPHINXOPTS = SPHINXOPTS =
SPHINXDIRS = . SPHINXDIRS = .
_SPHINXDIRS = $(patsubst $(srctree)/Documentation/%/conf.py,%,$(wildcard $(srctree)/Documentation/*/conf.py)) _SPHINXDIRS = $(patsubst $(srctree)/doc/%/conf.py,%,$(wildcard $(srctree)/doc/*/conf.py))
SPHINX_CONF = conf.py SPHINX_CONF = conf.py
PAPER = PAPER =
BUILDDIR = $(obj)/output BUILDDIR = $(obj)/output
@ -49,10 +49,10 @@ loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;
# * cache folder relative to $(BUILDDIR)/.doctrees # * cache folder relative to $(BUILDDIR)/.doctrees
# $4 dest subfolder e.g. "man" for man pages at media/man # $4 dest subfolder e.g. "man" for man pages at media/man
# $5 reST source folder relative to $(srctree)/$(src), # $5 reST source folder relative to $(srctree)/$(src),
# e.g. "media" for the linux-tv book-set at ./Documentation/media # e.g. "media" for the linux-tv book-set at ./doc/media
quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media $2 && \ cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media $2 && \
PYTHONDONTWRITEBYTECODE=1 \ PYTHONDONTWRITEBYTECODE=1 \
BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
$(SPHINXBUILD) \ $(SPHINXBUILD) \
@ -102,7 +102,7 @@ refcheckdocs:
cleandocs: cleandocs:
$(Q)rm -rf $(BUILDDIR) $(Q)rm -rf $(BUILDDIR)
$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media clean
dochelp: dochelp:
@echo ' Linux kernel internal documentation in different formats from ReST:' @echo ' Linux kernel internal documentation in different formats from ReST:'
@ -121,4 +121,4 @@ dochelp:
@echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build' @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
@echo ' configuration. This is e.g. useful to build with nit-picking config.' @echo ' configuration. This is e.g. useful to build with nit-picking config.'
@echo @echo
@echo ' Default location for the generated documents is Documentation/output' @echo ' Default location for the generated documents is doc/output'

View File

@ -1,7 +1,7 @@
# Rules to convert a .h file to inline RST documentation # Rules to convert a .h file to inline RST documentation
SRC_DIR=$(srctree)/Documentation/media SRC_DIR=$(srctree)/doc/media
PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl PARSER = $(srctree)/doc/sphinx/parse-headers.pl
API = $(srctree)/include API = $(srctree)/include
FILES = linker_lists.h.rst FILES = linker_lists.h.rst

View File

@ -382,7 +382,7 @@ ioctl.
The EXCEPTIONS_FILE contain two rules to allow ignoring a symbol or The EXCEPTIONS_FILE contain two rules to allow ignoring a symbol or
to replace the default references by a custom one. to replace the default references by a custom one.
Please read Documentation/doc-guide/parse-headers.rst at the Kernel's Please read doc/doc-guide/parse-headers.rst at the Kernel's
tree for more details. tree for more details.
=head1 BUGS =head1 BUGS

View File

@ -54,7 +54,7 @@ from docutils.utils import SystemMessagePropagation
# ============================================================================== # ==============================================================================
# The version numbering follows numbering of the specification # The version numbering follows numbering of the specification
# (Documentation/books/kernel-doc-HOWTO). # (doc/books/kernel-doc-HOWTO).
__version__ = '1.0' __version__ = '1.0'
PY3 = sys.version_info[0] == 3 PY3 = sys.version_info[0] == 3