doc: Remove duplicated documentation directory
authorBreno Matheus Lima <breno.lima@nxp.com>
Wed, 5 Jun 2019 18:18:30 +0000 (18:18 +0000)
committerTom Rini <trini@konsulko.com>
Thu, 20 Jun 2019 14:57:08 +0000 (10:57 -0400)
Commit ad7061ed742e ("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>
32 files changed:
MAINTAINERS
Makefile
doc/Makefile [moved from Documentation/Makefile with 91% similarity]
doc/conf.py [moved from Documentation/conf.py with 100% similarity]
doc/device-tree-bindings/arm/l2c2x0.txt [moved from Documentation/devicetree/bindings/arm/l2c2x0.txt with 100% similarity]
doc/device-tree-bindings/axi/gdsys,ihs_axi.txt [moved from Documentation/devicetree/bindings/axi/gdsys,ihs_axi.txt with 100% similarity]
doc/device-tree-bindings/board/gdsys,board_gazerbeam.txt [moved from Documentation/devicetree/bindings/board/gdsys,board_gazerbeam.txt with 100% similarity]
doc/device-tree-bindings/clock/fsl,mpc83xx-clk.txt [moved from Documentation/devicetree/bindings/clk/fsl,mpc83xx-clk.txt with 100% similarity]
doc/device-tree-bindings/cpu/fsl,mpc83xx.txt [moved from Documentation/devicetree/bindings/cpu/fsl,mpc83xx.txt with 100% similarity]
doc/device-tree-bindings/misc/misc/fsl,mpc83xx-serdes.txt [moved from Documentation/devicetree/bindings/misc/fsl,mpc83xx-serdes.txt with 100% similarity]
doc/device-tree-bindings/misc/misc/gdsys,io-endpoint.txt [moved from Documentation/devicetree/bindings/misc/gdsys,io-endpoint.txt with 100% similarity]
doc/device-tree-bindings/misc/misc/gdsys,iocon_fpga.txt [moved from Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt with 100% similarity]
doc/device-tree-bindings/misc/misc/gdsys,iocpu_fpga.txt [moved from Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt with 100% similarity]
doc/device-tree-bindings/misc/misc/gdsys,soc.txt [moved from Documentation/devicetree/bindings/misc/gdsys,soc.txt with 100% similarity]
doc/device-tree-bindings/ram/fsl,mpc83xx-mem-controller.txt [moved from Documentation/devicetree/bindings/ram/fsl,mpc83xx-mem-controller.txt with 100% similarity]
doc/device-tree-bindings/reserved-memory/reserved-memory.txt [moved from Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt with 100% similarity]
doc/device-tree-bindings/timer/fsl,mpc83xx-timer.txt [moved from Documentation/devicetree/bindings/timer/fsl,mpc83xx-timer.txt with 100% similarity]
doc/efi.rst [moved from Documentation/efi.rst with 100% similarity]
doc/index.rst [moved from Documentation/index.rst with 100% similarity]
doc/linker_lists.rst [moved from Documentation/linker_lists.rst with 100% similarity]
doc/media/Makefile [moved from Documentation/media/Makefile with 89% similarity]
doc/media/linker_lists.h.rst.exceptions [moved from Documentation/media/linker_lists.h.rst.exceptions with 100% similarity]
doc/serial.rst [moved from Documentation/serial.rst with 100% similarity]
doc/sphinx-static/theme_overrides.css [moved from Documentation/sphinx-static/theme_overrides.css with 100% similarity]
doc/sphinx/cdomain.py [moved from Documentation/sphinx/cdomain.py with 100% similarity]
doc/sphinx/kernel_include.py [moved from Documentation/sphinx/kernel_include.py with 100% similarity]
doc/sphinx/kerneldoc.py [moved from Documentation/sphinx/kerneldoc.py with 100% similarity]
doc/sphinx/kfigure.py [moved from Documentation/sphinx/kfigure.py with 100% similarity]
doc/sphinx/load_config.py [moved from Documentation/sphinx/load_config.py with 100% similarity]
doc/sphinx/parse-headers.pl [moved from Documentation/sphinx/parse-headers.pl with 99% similarity]
doc/sphinx/requirements.txt [moved from Documentation/sphinx/requirements.txt with 100% similarity]
doc/sphinx/rstFlatTable.py [moved from Documentation/sphinx/rstFlatTable.py with 99% similarity]

index 9046084..bea3122 100644 (file)
@@ -476,7 +476,7 @@ S:  Maintained
 T:     git https://gitlab.denx.de/u-boot/custodians/u-boot-efi.git
 F:     doc/README.uefi
 F:     doc/README.iscsi
-F:     Documentation/efi.rst
+F:     doc/efi.rst
 F:     include/capitalization.h
 F:     include/charset.h
 F:     include/cp1250.h
index 9fba74d..6335834 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -168,7 +168,7 @@ MAKEFLAGS += --no-print-directory
 # Use 'make C=2' to enable checking of *all* source files, regardless
 # 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.
 
 ifeq ("$(origin C)", "command line")
@@ -1916,7 +1916,7 @@ help:
        @echo  '  coccicheck      - Execute static code analysis with Coccinelle'
        @echo  ''
        @echo  'Documentation targets:'
-       @$(MAKE) -f $(srctree)/Documentation/Makefile dochelp
+       @$(MAKE) -f $(srctree)/doc/Makefile dochelp
        @echo  ''
        @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'
@@ -1945,7 +1945,7 @@ DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs \
               linkcheckdocs dochelp refcheckdocs
 PHONY += $(DOC_TARGETS)
 $(DOC_TARGETS): scripts_basic FORCE
-       $(Q)$(MAKE) $(build)=Documentation $@
+       $(Q)$(MAKE) $(build)=doc $@
 
 endif #ifeq ($(config-targets),1)
 endif #ifeq ($(mixed-targets),1)
similarity index 91%
rename from Documentation/Makefile
rename to doc/Makefile
index 2ca77ad..5135a96 100644 (file)
@@ -8,7 +8,7 @@ subdir-y :=
 SPHINXBUILD   = sphinx-build
 SPHINXOPTS    =
 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
 PAPER         =
 BUILDDIR      = $(obj)/output
@@ -49,10 +49,10 @@ loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;
 #    * cache folder relative to $(BUILDDIR)/.doctrees
 # $4 dest subfolder e.g. "man" for man pages at media/man
 # $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)
-      cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media $2 && \
+      cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media $2 && \
        PYTHONDONTWRITEBYTECODE=1 \
        BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
        $(SPHINXBUILD) \
@@ -102,7 +102,7 @@ refcheckdocs:
 
 cleandocs:
        $(Q)rm -rf $(BUILDDIR)
-       $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean
+       $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media clean
 
 dochelp:
        @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  '  configuration. This is e.g. useful to build with nit-picking config.'
        @echo
-       @echo  '  Default location for the generated documents is Documentation/output'
+       @echo  '  Default location for the generated documents is doc/output'
similarity index 100%
rename from Documentation/conf.py
rename to doc/conf.py
similarity index 100%
rename from Documentation/efi.rst
rename to doc/efi.rst
similarity index 100%
rename from Documentation/index.rst
rename to doc/index.rst
similarity index 89%
rename from Documentation/media/Makefile
rename to doc/media/Makefile
index 0efd18a..b9b43a3 100644 (file)
@@ -1,7 +1,7 @@
 # Rules to convert a .h file to inline RST documentation
 
-SRC_DIR=$(srctree)/Documentation/media
-PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
+SRC_DIR=$(srctree)/doc/media
+PARSER = $(srctree)/doc/sphinx/parse-headers.pl
 API = $(srctree)/include
 
 FILES = linker_lists.h.rst
similarity index 100%
rename from Documentation/serial.rst
rename to doc/serial.rst
similarity index 99%
rename from Documentation/sphinx/parse-headers.pl
rename to doc/sphinx/parse-headers.pl
index d410f47..d4f3826 100755 (executable)
@@ -382,7 +382,7 @@ ioctl.
 The EXCEPTIONS_FILE contain two rules to allow ignoring a symbol or
 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.
 
 =head1 BUGS
similarity index 99%
rename from Documentation/sphinx/rstFlatTable.py
rename to doc/sphinx/rstFlatTable.py
index 25feb0d..f9a4b46 100755 (executable)
@@ -54,7 +54,7 @@ from docutils.utils import SystemMessagePropagation
 # ==============================================================================
 
 # The version numbering follows numbering of the specification
-# (Documentation/books/kernel-doc-HOWTO).
+# (doc/books/kernel-doc-HOWTO).
 __version__  = '1.0'
 
 PY3 = sys.version_info[0] == 3