Skip to contentSkip to conversation

doc: Remove duplicated documentation directory

PATCH New Breno Matheus Lima 2 participants 2 messages Jun 5, 2019 – Jun 21, 2019

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 MAINTAINERS                                            |  2 +-
 Makefile                                               |  6 +++---
 {Documentation => doc}/Makefile                        | 10 +++++-----
 {Documentation => doc}/conf.py                         |  0
 .../device-tree-bindings}/arm/l2c2x0.txt               |  0
 .../device-tree-bindings}/axi/gdsys,ihs_axi.txt        |  0
 .../board/gdsys,board_gazerbeam.txt                    |  0
 .../device-tree-bindings/clock}/fsl,mpc83xx-clk.txt    |  0
 .../device-tree-bindings}/cpu/fsl,mpc83xx.txt          |  0
 .../misc}/misc/fsl,mpc83xx-serdes.txt                  |  0
 .../misc}/misc/gdsys,io-endpoint.txt                   |  0
 .../misc}/misc/gdsys,iocon_fpga.txt                    |  0
 .../misc}/misc/gdsys,iocpu_fpga.txt                    |  0
 .../device-tree-bindings/misc}/misc/gdsys,soc.txt      |  0
 .../ram/fsl,mpc83xx-mem-controller.txt                 |  0
 .../reserved-memory/reserved-memory.txt                |  0
 .../device-tree-bindings}/timer/fsl,mpc83xx-timer.txt  |  0
 {Documentation => doc}/efi.rst                         |  0
 {Documentation => doc}/index.rst                       |  0
 {Documentation => doc}/linker_lists.rst                |  0
 {Documentation => doc}/media/Makefile                  |  4 ++--
 .../media/linker_lists.h.rst.exceptions                |  0
 {Documentation => doc}/serial.rst                      |  0
 .../sphinx-static/theme_overrides.css                  |  0
 {Documentation => doc}/sphinx/cdomain.py               |  0
 {Documentation => doc}/sphinx/kernel_include.py        |  0
 {Documentation => doc}/sphinx/kerneldoc.py             |  0
 {Documentation => doc}/sphinx/kfigure.py               |  0
 {Documentation => doc}/sphinx/load_config.py           |  0
 {Documentation => doc}/sphinx/parse-headers.pl         |  2 +-
 {Documentation => doc}/sphinx/requirements.txt         |  0
 {Documentation => doc}/sphinx/rstFlatTable.py          |  2 +-
 32 files changed, 13 insertions(+), 13 deletions(-)
 rename {Documentation => doc}/Makefile (91%)
 rename {Documentation => doc}/conf.py (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/arm/l2c2x0.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/axi/gdsys,ihs_axi.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/board/gdsys,board_gazerbeam.txt (100%)
 rename {Documentation/devicetree/bindings/clk => doc/device-tree-bindings/clock}/fsl,mpc83xx-clk.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/cpu/fsl,mpc83xx.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings/misc}/misc/fsl,mpc83xx-serdes.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings/misc}/misc/gdsys,io-endpoint.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings/misc}/misc/gdsys,iocon_fpga.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings/misc}/misc/gdsys,iocpu_fpga.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings/misc}/misc/gdsys,soc.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/ram/fsl,mpc83xx-mem-controller.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/reserved-memory/reserved-memory.txt (100%)
 rename {Documentation/devicetree/bindings => doc/device-tree-bindings}/timer/fsl,mpc83xx-timer.txt (100%)
 rename {Documentation => doc}/efi.rst (100%)
 rename {Documentation => doc}/index.rst (100%)
 rename {Documentation => doc}/linker_lists.rst (100%)
 rename {Documentation => doc}/media/Makefile (89%)
 rename {Documentation => doc}/media/linker_lists.h.rst.exceptions (100%)
 rename {Documentation => doc}/serial.rst (100%)
 rename {Documentation => doc}/sphinx-static/theme_overrides.css (100%)
 rename {Documentation => doc}/sphinx/cdomain.py (100%)
 rename {Documentation => doc}/sphinx/kernel_include.py (100%)
 rename {Documentation => doc}/sphinx/kerneldoc.py (100%)
 rename {Documentation => doc}/sphinx/kfigure.py (100%)
 rename {Documentation => doc}/sphinx/load_config.py (100%)
 rename {Documentation => doc}/sphinx/parse-headers.pl (99%)
 rename {Documentation => doc}/sphinx/requirements.txt (100%)
 rename {Documentation => doc}/sphinx/rstFlatTable.py (99%)
MAINTAINERS +1 -1
index 33fd4652a4..78872169cd 100644
@@ -474,7 +474,7 @@ S:	Maintained
 T:	git git://git.denx.de/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/cp1250.h
 F:	include/cp437.h
Makefile +3 -3
index 9fb90c0779..e4c2d4a517 100644
@@ -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")
@@ -1883,7 +1883,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'
@@ -1912,7 +1912,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)
doc/Makefile renamed from Documentation/Makefile +5 -5
similarity index 91%
rename from Documentation/Makefile
rename to doc/Makefile
index 2ca77ad0f2..5135a96e88 100644
@@ -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'
doc/conf.py renamed from Documentation/conf.py +0 -0
similarity index 100%
rename from Documentation/conf.py
rename to doc/conf.py
doc/device-tree-bindings/arm/l2c2x0.txt renamed from Documentation/devicetree/bindings/arm/l2c2x0.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/arm/l2c2x0.txt
rename to doc/device-tree-bindings/arm/l2c2x0.txt
doc/device-tree-bindings/axi/gdsys,ihs_axi.txt renamed from Documentation/devicetree/bindings/axi/gdsys,ihs_axi.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/axi/gdsys,ihs_axi.txt
rename to doc/device-tree-bindings/axi/gdsys,ihs_axi.txt
doc/device-tree-bindings/board/gdsys,board_gazerbeam.txt renamed from Documentation/devicetree/bindings/board/gdsys,board_gazerbeam.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/board/gdsys,board_gazerbeam.txt
rename to doc/device-tree-bindings/board/gdsys,board_gazerbeam.txt
doc/device-tree-bindings/clock/fsl,mpc83xx-clk.txt renamed from Documentation/devicetree/bindings/clk/fsl,mpc83xx-clk.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/clk/fsl,mpc83xx-clk.txt
rename to doc/device-tree-bindings/clock/fsl,mpc83xx-clk.txt
doc/device-tree-bindings/cpu/fsl,mpc83xx.txt renamed from Documentation/devicetree/bindings/cpu/fsl,mpc83xx.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/cpu/fsl,mpc83xx.txt
rename to doc/device-tree-bindings/cpu/fsl,mpc83xx.txt
doc/device-tree-bindings/misc/misc/fsl,mpc83xx-serdes.txt renamed from Documentation/devicetree/bindings/misc/fsl,mpc83xx-serdes.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/misc/fsl,mpc83xx-serdes.txt
rename to doc/device-tree-bindings/misc/misc/fsl,mpc83xx-serdes.txt
doc/device-tree-bindings/misc/misc/gdsys,io-endpoint.txt renamed from Documentation/devicetree/bindings/misc/gdsys,io-endpoint.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/misc/gdsys,io-endpoint.txt
rename to doc/device-tree-bindings/misc/misc/gdsys,io-endpoint.txt
doc/device-tree-bindings/misc/misc/gdsys,iocon_fpga.txt renamed from Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt
rename to doc/device-tree-bindings/misc/misc/gdsys,iocon_fpga.txt
doc/device-tree-bindings/misc/misc/gdsys,iocpu_fpga.txt renamed from Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt
rename to doc/device-tree-bindings/misc/misc/gdsys,iocpu_fpga.txt
doc/device-tree-bindings/misc/misc/gdsys,soc.txt renamed from Documentation/devicetree/bindings/misc/gdsys,soc.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/misc/gdsys,soc.txt
rename to doc/device-tree-bindings/misc/misc/gdsys,soc.txt
doc/device-tree-bindings/ram/fsl,mpc83xx-mem-controller.txt renamed from Documentation/devicetree/bindings/ram/fsl,mpc83xx-mem-controller.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/ram/fsl,mpc83xx-mem-controller.txt
rename to doc/device-tree-bindings/ram/fsl,mpc83xx-mem-controller.txt
doc/device-tree-bindings/reserved-memory/reserved-memory.txt renamed from Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt
rename to doc/device-tree-bindings/reserved-memory/reserved-memory.txt
doc/device-tree-bindings/timer/fsl,mpc83xx-timer.txt renamed from Documentation/devicetree/bindings/timer/fsl,mpc83xx-timer.txt +0 -0
similarity index 100%
rename from Documentation/devicetree/bindings/timer/fsl,mpc83xx-timer.txt
rename to doc/device-tree-bindings/timer/fsl,mpc83xx-timer.txt
doc/efi.rst renamed from Documentation/efi.rst +0 -0
similarity index 100%
rename from Documentation/efi.rst
rename to doc/efi.rst
doc/index.rst renamed from Documentation/index.rst +0 -0
similarity index 100%
rename from Documentation/index.rst
rename to doc/index.rst
doc/linker_lists.rst renamed from Documentation/linker_lists.rst +0 -0
similarity index 100%
rename from Documentation/linker_lists.rst
rename to doc/linker_lists.rst
doc/media/Makefile renamed from Documentation/media/Makefile +2 -2
similarity index 89%
rename from Documentation/media/Makefile
rename to doc/media/Makefile
index 0efd18ab4d..b9b43a34c3 100644
@@ -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
doc/media/linker_lists.h.rst.exceptions renamed from Documentation/media/linker_lists.h.rst.exceptions +0 -0
similarity index 100%
rename from Documentation/media/linker_lists.h.rst.exceptions
rename to doc/media/linker_lists.h.rst.exceptions
doc/serial.rst renamed from Documentation/serial.rst +0 -0
similarity index 100%
rename from Documentation/serial.rst
rename to doc/serial.rst
doc/sphinx-static/theme_overrides.css renamed from Documentation/sphinx-static/theme_overrides.css +0 -0
similarity index 100%
rename from Documentation/sphinx-static/theme_overrides.css
rename to doc/sphinx-static/theme_overrides.css
doc/sphinx/cdomain.py renamed from Documentation/sphinx/cdomain.py +0 -0
similarity index 100%
rename from Documentation/sphinx/cdomain.py
rename to doc/sphinx/cdomain.py
doc/sphinx/kernel_include.py renamed from Documentation/sphinx/kernel_include.py +0 -0
similarity index 100%
rename from Documentation/sphinx/kernel_include.py
rename to doc/sphinx/kernel_include.py
doc/sphinx/kerneldoc.py renamed from Documentation/sphinx/kerneldoc.py +0 -0
similarity index 100%
rename from Documentation/sphinx/kerneldoc.py
rename to doc/sphinx/kerneldoc.py
doc/sphinx/kfigure.py renamed from Documentation/sphinx/kfigure.py +0 -0
similarity index 100%
rename from Documentation/sphinx/kfigure.py
rename to doc/sphinx/kfigure.py
doc/sphinx/load_config.py renamed from Documentation/sphinx/load_config.py +0 -0
similarity index 100%
rename from Documentation/sphinx/load_config.py
rename to doc/sphinx/load_config.py
doc/sphinx/parse-headers.pl renamed from Documentation/sphinx/parse-headers.pl +1 -1
similarity index 99%
rename from Documentation/sphinx/parse-headers.pl
rename to doc/sphinx/parse-headers.pl
index d410f47567..d4f38262eb 100755
@@ -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
doc/sphinx/requirements.txt renamed from Documentation/sphinx/requirements.txt +0 -0
similarity index 100%
rename from Documentation/sphinx/requirements.txt
rename to doc/sphinx/requirements.txt
doc/sphinx/rstFlatTable.py renamed from Documentation/sphinx/rstFlatTable.py +1 -1
similarity index 99%
rename from Documentation/sphinx/rstFlatTable.py
rename to doc/sphinx/rstFlatTable.py
index 25feb0d35e..f9a4b46dbe 100755
@@ -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
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/1 doc: Remove duplicated documentation directory

Quoted 6 lines · Breno Matheus Lima

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:

Quoted 7 lines

- doc/
- Documentation/

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

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190620/23f2be31/attachment.sig>