Browse Source

doc: Remove duplicated documentation directory

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>
Breno Matheus Lima 4 years ago
parent
commit
656d8da9d2

+ 1 - 1
MAINTAINERS

@@ -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

+ 3 - 3
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)

+ 5 - 5
Documentation/Makefile → doc/Makefile

@@ -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'

+ 0 - 0
Documentation/conf.py → doc/conf.py


+ 0 - 0
Documentation/devicetree/bindings/arm/l2c2x0.txt → doc/device-tree-bindings/arm/l2c2x0.txt


+ 0 - 0
Documentation/devicetree/bindings/axi/gdsys,ihs_axi.txt → doc/device-tree-bindings/axi/gdsys,ihs_axi.txt


+ 0 - 0
Documentation/devicetree/bindings/board/gdsys,board_gazerbeam.txt → doc/device-tree-bindings/board/gdsys,board_gazerbeam.txt


+ 0 - 0
Documentation/devicetree/bindings/clk/fsl,mpc83xx-clk.txt → doc/device-tree-bindings/clock/fsl,mpc83xx-clk.txt


+ 0 - 0
Documentation/devicetree/bindings/cpu/fsl,mpc83xx.txt → doc/device-tree-bindings/cpu/fsl,mpc83xx.txt


+ 0 - 0
Documentation/devicetree/bindings/misc/fsl,mpc83xx-serdes.txt → doc/device-tree-bindings/misc/misc/fsl,mpc83xx-serdes.txt


+ 0 - 0
Documentation/devicetree/bindings/misc/gdsys,io-endpoint.txt → doc/device-tree-bindings/misc/misc/gdsys,io-endpoint.txt


+ 0 - 0
Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt → doc/device-tree-bindings/misc/misc/gdsys,iocon_fpga.txt


+ 0 - 0
Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt → doc/device-tree-bindings/misc/misc/gdsys,iocpu_fpga.txt


+ 0 - 0
Documentation/devicetree/bindings/misc/gdsys,soc.txt → doc/device-tree-bindings/misc/misc/gdsys,soc.txt


+ 0 - 0
Documentation/devicetree/bindings/ram/fsl,mpc83xx-mem-controller.txt → doc/device-tree-bindings/ram/fsl,mpc83xx-mem-controller.txt


+ 0 - 0
Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt → doc/device-tree-bindings/reserved-memory/reserved-memory.txt


+ 0 - 0
Documentation/devicetree/bindings/timer/fsl,mpc83xx-timer.txt → doc/device-tree-bindings/timer/fsl,mpc83xx-timer.txt


+ 0 - 0
Documentation/efi.rst → doc/efi.rst


+ 0 - 0
Documentation/index.rst → doc/index.rst


+ 0 - 0
Documentation/linker_lists.rst → doc/linker_lists.rst


+ 2 - 2
Documentation/media/Makefile → doc/media/Makefile

@@ -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

+ 0 - 0
Documentation/media/linker_lists.h.rst.exceptions → doc/media/linker_lists.h.rst.exceptions


+ 0 - 0
Documentation/serial.rst → doc/serial.rst


+ 0 - 0
Documentation/sphinx-static/theme_overrides.css → doc/sphinx-static/theme_overrides.css


+ 0 - 0
Documentation/sphinx/cdomain.py → doc/sphinx/cdomain.py


+ 0 - 0
Documentation/sphinx/kernel_include.py → doc/sphinx/kernel_include.py


+ 0 - 0
Documentation/sphinx/kerneldoc.py → doc/sphinx/kerneldoc.py


+ 0 - 0
Documentation/sphinx/kfigure.py → doc/sphinx/kfigure.py


+ 0 - 0
Documentation/sphinx/load_config.py → doc/sphinx/load_config.py


+ 1 - 1
Documentation/sphinx/parse-headers.pl → doc/sphinx/parse-headers.pl

@@ -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

+ 0 - 0
Documentation/sphinx/requirements.txt → doc/sphinx/requirements.txt


+ 1 - 1
Documentation/sphinx/rstFlatTable.py → doc/sphinx/rstFlatTable.py

@@ -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