[PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

[PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

[Markus Heiser]

From: Markus Heiser <markus.heiser@darmarIT.de>

Hi Mauro,

this is my approach for a more generic way to build only sphinx sub-folders, we
discussed in [1]. The last patch adds a minimal conf.py to the gpu folder, if
you don't want to patch the gpu folder drop it.

[1] http://marc.info/?t=147051523900002

Markus Heiser (3):
  doc-rst: generic way to build only sphinx sub-folders
  doc-rst: add stand-alone conf.py to media folder
  doc-rst: add stand-alone conf.py to gpu folder

 Documentation/DocBook/Makefile      |   2 +-
 Documentation/Makefile.sphinx       |  52 +++++++++----
 Documentation/gpu/conf.py           |   3 +
 Documentation/media/conf.py         |   3 +
 Documentation/media/conf_nitpick.py | 150 +++++++++++++++++++-----------------
 Documentation/sphinx/load_config.py |  20 +++--
 Makefile                            |   6 --
 7 files changed, 137 insertions(+), 99 deletions(-)
 create mode 100644 Documentation/gpu/conf.py
 create mode 100644 Documentation/media/conf.py

-- 
2.7.4

[PATCH 1/3] doc-rst: generic way to build only sphinx sub-folders

[Markus Heiser]

From: Markus Heiser <markus.heiser@darmarIT.de>

Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a
more generic way to build only a reST sub-folder.

* control *sub-folders* by environment SPHINXDIRS
* control *build-theme* by environment SPHINX_CONF

Folders with a conf.py file, matching $(srctree)/Documentation/*/conf.py
can be build and distributed *stand-alone*. E.g. to compile only the
html of 'media' and 'gpu' folder use::

  make SPHINXDIRS="media gpu" htmldocs

To use an additional sphinx-build configuration (*build-theme*) set the
name of the configuration file to SPHINX_CONF. E.g. to compile only the
html of 'media' with the *nit-picking* build use::

  make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs

With this, the Documentation/conf.py is read first and updated with the
configuration values from the Documentation/media/conf_nitpick.py.

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
---
 Documentation/DocBook/Makefile      |  2 +-
 Documentation/Makefile.sphinx       | 52 +++++++++++++++++++++++++++----------
 Documentation/sphinx/load_config.py | 20 +++++++++-----
 Makefile                            |  6 -----
 4 files changed, 53 insertions(+), 27 deletions(-)

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index c481df3..24fd36d 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -6,7 +6,7 @@
 # To add a new book the only step required is to add the book to the
 # list of DOCBOOKS.
 
-ifeq ($(IGNORE_DOCBOOKS),)
+ifeq ($(IGNORE_DOCBOOKS)$(SPHINXDIRS),)
 
 DOCBOOKS := z8530book.xml device-drivers.xml \
 	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index bbd7cd4..1549237 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -5,9 +5,13 @@
 # You can set these variables from the command line.
 SPHINXBUILD   = sphinx-build
 SPHINXOPTS    =
+SPHINXDIRS    = .
+_SPHINXDIRS   = $(patsubst $(srctree)/Documentation/%/conf.py,%,$(wildcard $(srctree)/Documentation/*/conf.py))
+SPHINX_CONF   = conf.py
 PAPER         =
 BUILDDIR      = $(obj)/output
 
+
 # User-friendly check for sphinx-build
 HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
 
@@ -33,35 +37,50 @@ PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 KERNELDOC       = $(srctree)/scripts/kernel-doc
 KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
-ALLSPHINXOPTS   = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(BUILDDIR)/.doctrees $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS)
+ALLSPHINXOPTS   =  $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-quiet_cmd_sphinx = SPHINX  $@
-      cmd_sphinx = BUILDDIR=$(BUILDDIR) $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(srctree)/$(src)$3 $(BUILDDIR)/$2
-
-# Build only the media docs, in nitpick mode
-mediadocs:
-	$(MAKE) BUILDDIR=$(BUILDDIR) SPHINX_CONF=media/conf_nitpick.py -f $(srctree)/Documentation/media/Makefile htmldocs
-	$(call cmd,sphinx,html,/media)
+# commands; the 'cmd' from scripts/Kbuild.include is not *loopable*
+loop_cmd = $(echo-cmd) $(cmd_$(1))
+
+# $2 sphinx builder e.g. "html"
+# $3 name of the build subfolder / e.g. "media", used as:
+#    * dest folder relative to $(BUILDDIR) and
+#    * 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
+
+quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4);
+      cmd_sphinx = BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
+	$(SPHINXBUILD) \
+	-b $2 \
+	-c $(abspath $(srctree)/$(src)) \
+	-d $(abspath $(BUILDDIR)/.doctrees/$3) \
+	-D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
+	$(ALLSPHINXOPTS) \
+	$(abspath $(srctree)/$(src)/$5) \
+	$(abspath $(BUILDDIR)/$3/$4);
 
 htmldocs:
-	$(MAKE) BUILDDIR=$(BUILDDIR) -f $(srctree)/Documentation/media/Makefile $@
-	$(call cmd,sphinx,html)
+	$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) -f $(srctree)/Documentation/media/Makefile $@
+	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
+
 
 pdfdocs:
 ifeq ($(HAVE_RST2PDF),0)
 	$(warning The Python 'rst2pdf' module was not found. Make sure you have the module installed to produce PDF output.)
 	@echo "  SKIP    Sphinx $@ target."
 else # HAVE_RST2PDF
-	$(call cmd,sphinx,pdf)
+	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,pdf,$(var),pdf,$(var)))
 endif # HAVE_RST2PDF
 
 epubdocs:
-	$(call cmd,sphinx,epub)
+	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
 
 xmldocs:
-	$(call cmd,sphinx,xml)
+	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
 
 # no-ops for the Sphinx toolchain
 sgmldocs:
@@ -75,10 +94,15 @@ cleandocs:
 dochelp:
 	@echo  ' Linux kernel internal documentation in different formats (Sphinx):'
 	@echo  '  htmldocs        - HTML'
-	@echo  '  mediadocs       - built only media books in HTML on nitpick mode'
 	@echo  '  pdfdocs         - PDF'
 	@echo  '  epubdocs        - EPUB'
 	@echo  '  xmldocs         - XML'
 	@echo  '  cleandocs       - clean all generated files'
+	@echo
+	@echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
+	@echo  '  valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
+	@echo
+	@echo  '  make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
+	@echo  '  configuration. This is e.g. useful to build with nit-picking config.'
 
 endif # HAVE_SPHINX
diff --git a/Documentation/sphinx/load_config.py b/Documentation/sphinx/load_config.py
index 44bdd22..88e5e4a 100644
--- a/Documentation/sphinx/load_config.py
+++ b/Documentation/sphinx/load_config.py
@@ -2,6 +2,7 @@
 # pylint: disable=R0903, C0330, R0914, R0912, E0401
 
 import os
+import sys
 from sphinx.util.pycompat import execfile_
 
 # ------------------------------------------------------------------------------
@@ -16,10 +17,17 @@ def loadConfig(namespace):
     maintain *build themes*.  """
 
     config_file = os.environ.get("SPHINX_CONF", None)
-    if config_file is not None and os.path.exists(config_file):
+    if (config_file is not None
+        and os.path.normpath(namespace["__file__"]) != os.path.normpath(config_file) ):
         config_file = os.path.abspath(config_file)
-        config = namespace.copy()
-        config['__file__'] = config_file
-        execfile_(config_file, config)
-        del config['__file__']
-        namespace.update(config)
+
+        if os.path.isfile(config_file):
+            sys.stdout.write("load additional sphinx-config: %s\n" % config_file)
+            config = namespace.copy()
+            config['__file__'] = config_file
+            execfile_(config_file, config)
+            del config['__file__']
+            namespace.update(config)
+        else:
+            sys.stderr.write("WARNING: additional sphinx-config not found: %s\n" % config_file)
+
diff --git a/Makefile b/Makefile
index 08ef6c1..3560355 100644
--- a/Makefile
+++ b/Makefile
@@ -1439,12 +1439,6 @@ $(DOC_TARGETS): scripts_basic FORCE
 	$(Q)$(MAKE) $(build)=Documentation -f $(srctree)/Documentation/Makefile.sphinx $@
 	$(Q)$(MAKE) $(build)=Documentation/DocBook $@
 
-DOC_NITPIC_TARGETS := mediadocs
-PHONY += $(DOC_NITPIC_TARGETS)
-$(DOC_NITPIC_TARGETS): scripts_basic FORCE
-	$(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype
-	$(Q)$(MAKE) $(build)=Documentation -f $(srctree)/Documentation/Makefile.sphinx $@
-
 else # KBUILD_EXTMOD
 
 ###
-- 
2.7.4

[PATCH 2/3] doc-rst: add stand-alone conf.py to media folder

[Markus Heiser]

From: Markus Heiser <markus.heiser@darmarIT.de>

With the media/conf.py, the media folder can be build and distributed
stand-alone. BTW fixed python indentation in media/conf_nitpick.py.
Python indentation is 4 spaces [1] and Python 3 disallows mixing the use
of tabs and spaces for indentation.

[1] https://www.python.org/dev/peps/pep-0008/#indentation
[2] https://www.python.org/dev/peps/pep-0008/#tabs-or-spaces

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
---
 Documentation/media/conf.py         |   3 +
 Documentation/media/conf_nitpick.py | 150 +++++++++++++++++++-----------------
 2 files changed, 81 insertions(+), 72 deletions(-)
 create mode 100644 Documentation/media/conf.py

diff --git a/Documentation/media/conf.py b/Documentation/media/conf.py
new file mode 100644
index 0000000..62bdba2
--- /dev/null
+++ b/Documentation/media/conf.py
@@ -0,0 +1,3 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = 'Linux Media Subsystem Documentation'
diff --git a/Documentation/media/conf_nitpick.py b/Documentation/media/conf_nitpick.py
index 9034d7f..e794e3d 100644
--- a/Documentation/media/conf_nitpick.py
+++ b/Documentation/media/conf_nitpick.py
@@ -1,4 +1,10 @@
-nitpicky=True
+# -*- coding: utf-8; mode: python -*-
+
+project = 'Linux Media Subsystem Documentation'
+# within nit-picking build, do not refer to any intersphinx object
+intersphinx_mapping = {}
+
+nitpicky = True
 
 # It is possible to run Sphinx in nickpick mode with:
 #	make SPHINXOPTS=-n htmldocs
@@ -10,76 +16,76 @@ nitpicky=True
 # The list below has a list of such symbols to be ignored in nitpick mode
 #
 nitpick_ignore = [
-	("c:func", "clock_gettime"),
-	("c:func", "close"),
-	("c:func", "container_of"),
-	("c:func", "determine_valid_ioctls"),
-	("c:func", "ERR_PTR"),
-	("c:func", "ioctl"),
-	("c:func", "IS_ERR"),
-	("c:func", "mmap"),
-	("c:func", "open"),
-	("c:func", "pci_name"),
-	("c:func", "poll"),
-	("c:func", "PTR_ERR"),
-	("c:func", "read"),
-	("c:func", "release"),
-	("c:func", "set"),
-	("c:func", "struct fd_set"),
-	("c:func", "struct pollfd"),
-	("c:func", "usb_make_path"),
-	("c:func", "write"),
-	("c:type", "atomic_t"),
-	("c:type", "bool"),
-	("c:type", "buf_queue"),
-	("c:type", "device"),
-	("c:type", "device_driver"),
-	("c:type", "device_node"),
-	("c:type", "enum"),
-	("c:type", "file"),
-	("c:type", "i2c_adapter"),
-	("c:type", "i2c_board_info"),
-	("c:type", "i2c_client"),
-	("c:type", "ktime_t"),
-	("c:type", "led_classdev_flash"),
-	("c:type", "list_head"),
-	("c:type", "lock_class_key"),
-	("c:type", "module"),
-	("c:type", "mutex"),
-	("c:type", "pci_dev"),
-	("c:type", "pdvbdev"),
-	("c:type", "poll_table_struct"),
-	("c:type", "s32"),
-	("c:type", "s64"),
-	("c:type", "sd"),
-	("c:type", "spi_board_info"),
-	("c:type", "spi_device"),
-	("c:type", "spi_master"),
-	("c:type", "struct fb_fix_screeninfo"),
-	("c:type", "struct pollfd"),
-	("c:type", "struct timeval"),
-	("c:type", "struct video_capability"),
-	("c:type", "u16"),
-	("c:type", "u32"),
-	("c:type", "u64"),
-	("c:type", "u8"),
-	("c:type", "union"),
-	("c:type", "usb_device"),
+    ("c:func", "clock_gettime"),
+    ("c:func", "close"),
+    ("c:func", "container_of"),
+    ("c:func", "determine_valid_ioctls"),
+    ("c:func", "ERR_PTR"),
+    ("c:func", "ioctl"),
+    ("c:func", "IS_ERR"),
+    ("c:func", "mmap"),
+    ("c:func", "open"),
+    ("c:func", "pci_name"),
+    ("c:func", "poll"),
+    ("c:func", "PTR_ERR"),
+    ("c:func", "read"),
+    ("c:func", "release"),
+    ("c:func", "set"),
+    ("c:func", "struct fd_set"),
+    ("c:func", "struct pollfd"),
+    ("c:func", "usb_make_path"),
+    ("c:func", "write"),
+    ("c:type", "atomic_t"),
+    ("c:type", "bool"),
+    ("c:type", "buf_queue"),
+    ("c:type", "device"),
+    ("c:type", "device_driver"),
+    ("c:type", "device_node"),
+    ("c:type", "enum"),
+    ("c:type", "file"),
+    ("c:type", "i2c_adapter"),
+    ("c:type", "i2c_board_info"),
+    ("c:type", "i2c_client"),
+    ("c:type", "ktime_t"),
+    ("c:type", "led_classdev_flash"),
+    ("c:type", "list_head"),
+    ("c:type", "lock_class_key"),
+    ("c:type", "module"),
+    ("c:type", "mutex"),
+    ("c:type", "pci_dev"),
+    ("c:type", "pdvbdev"),
+    ("c:type", "poll_table_struct"),
+    ("c:type", "s32"),
+    ("c:type", "s64"),
+    ("c:type", "sd"),
+    ("c:type", "spi_board_info"),
+    ("c:type", "spi_device"),
+    ("c:type", "spi_master"),
+    ("c:type", "struct fb_fix_screeninfo"),
+    ("c:type", "struct pollfd"),
+    ("c:type", "struct timeval"),
+    ("c:type", "struct video_capability"),
+    ("c:type", "u16"),
+    ("c:type", "u32"),
+    ("c:type", "u64"),
+    ("c:type", "u8"),
+    ("c:type", "union"),
+    ("c:type", "usb_device"),
 
-	("cpp:type", "boolean"),
-	("cpp:type", "fd"),
-	("cpp:type", "fd_set"),
-	("cpp:type", "int16_t"),
-	("cpp:type", "NULL"),
-	("cpp:type", "off_t"),
-	("cpp:type", "pollfd"),
-	("cpp:type", "size_t"),
-	("cpp:type", "ssize_t"),
-	("cpp:type", "timeval"),
-	("cpp:type", "__u16"),
-	("cpp:type", "__u32"),
-	("cpp:type", "__u64"),
-	("cpp:type", "uint16_t"),
-	("cpp:type", "uint32_t"),
-	("cpp:type", "video_system_t"),
+    ("cpp:type", "boolean"),
+    ("cpp:type", "fd"),
+    ("cpp:type", "fd_set"),
+    ("cpp:type", "int16_t"),
+    ("cpp:type", "NULL"),
+    ("cpp:type", "off_t"),
+    ("cpp:type", "pollfd"),
+    ("cpp:type", "size_t"),
+    ("cpp:type", "ssize_t"),
+    ("cpp:type", "timeval"),
+    ("cpp:type", "__u16"),
+    ("cpp:type", "__u32"),
+    ("cpp:type", "__u64"),
+    ("cpp:type", "uint16_t"),
+    ("cpp:type", "uint32_t"),
+    ("cpp:type", "video_system_t"),
 ]
-- 
2.7.4

[PATCH 3/3] doc-rst: add stand-alone conf.py to gpu folder

[Markus Heiser]

From: Markus Heiser <markus.heiser@darmarIT.de>

With the gpu/conf.py, the gpu folder can be build and distributed
stand-alone.

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
---
 Documentation/gpu/conf.py | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 Documentation/gpu/conf.py

diff --git a/Documentation/gpu/conf.py b/Documentation/gpu/conf.py
new file mode 100644
index 0000000..d60bcd0
--- /dev/null
+++ b/Documentation/gpu/conf.py
@@ -0,0 +1,3 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = "Linux GPU Driver Developer's Guide"
-- 
2.7.4

Re: [PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

[Jonathan Corbet]

On Mon,  8 Aug 2016 15:14:57 +0200
Markus Heiser <markus.heiser@darmarit.de> wrote:

> this is my approach for a more generic way to build only sphinx sub-folders, we
> discussed in [1]. The last patch adds a minimal conf.py to the gpu folder, if
> you don't want to patch the gpu folder drop it.

I haven't had a chance to really mess with this yet, but it seems like a
reasonable solution.  Mauro, does it give you what you need?

Thanks,

jon

Re: [PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

[Mauro Carvalho Chehab]

Em Tue, 9 Aug 2016 09:21:08 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Mon,  8 Aug 2016 15:14:57 +0200
> Markus Heiser <markus.heiser@darmarit.de> wrote:
> 
> > this is my approach for a more generic way to build only sphinx sub-folders, we
> > discussed in [1]. The last patch adds a minimal conf.py to the gpu folder, if
> > you don't want to patch the gpu folder drop it.  
> 
> I haven't had a chance to really mess with this yet, but it seems like a
> reasonable solution. 

Agreed.

> Mauro, does it give you what you need?

Yes. Just tested it here, and it works fine, allowing to build
everything, just one of the books and the media book with the nitpick
configuration.

Acked-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Please notice that Markus based his patch on my previous patch
series.

So, if it is easier for you, you could pull them altogether from my tree:

	git://linuxtv.org/mchehab/experimental.git docs-next

Or otherwise just pick the individual patches, adding my ack on the
Markus ones.

Thanks,
Mauro

The following changes since commit a157b3aaa44829998d5a079174df989e5d8c20ff:

  Merge tag 'pwm/for-4.8-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm (2016-08-06 00:01:33 -0400)

are available in the git repository at:

  docs-next 

for you to fetch changes up to 78c63a7a941d053a7dfaf787b586ff25a8e2fae9:

  doc-rst: add stand-alone conf.py to gpu folder (2016-08-09 14:48:01 -0300)

----------------------------------------------------------------
Markus Heiser (4):
      doc-rst: support additional Sphinx build config override
      doc-rst: generic way to build only sphinx sub-folders
      doc-rst: add stand-alone conf.py to media folder
      doc-rst: add stand-alone conf.py to gpu folder

Mauro Carvalho Chehab (2):
      doc-rst: add an option to build media documentation in nitpick mode
      doc-rst: remove a bogus comment from Documentation/index.rst

 Documentation/DocBook/Makefile      |  2 +-
 Documentation/Makefile.sphinx       | 46 ++++++++++++++++++++++++++++++++++++++--------
 Documentation/conf.py               |  9 +++++++++
 Documentation/gpu/conf.py           |  3 +++
 Documentation/index.rst             |  7 +------
 Documentation/media/conf.py         |  3 +++
 Documentation/media/conf_nitpick.py | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 Documentation/media/index.rst       | 12 ++++++++++++
 Documentation/sphinx/load_config.py | 32 ++++++++++++++++++++++++++++++++
 9 files changed, 190 insertions(+), 15 deletions(-)
 create mode 100644 Documentation/gpu/conf.py
 create mode 100644 Documentation/media/conf.py
 create mode 100644 Documentation/media/conf_nitpick.py
 create mode 100644 Documentation/media/index.rst
 create mode 100644 Documentation/sphinx/load_config.py

Re: [PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

[Markus Heiser]

Am 09.08.2016 um 20:02 schrieb Mauro Carvalho Chehab <mchehab@s-opensource.com>:

> Em Tue, 9 Aug 2016 09:21:08 -0600
> Jonathan Corbet <corbet@lwn.net> escreveu:
> 
>> On Mon,  8 Aug 2016 15:14:57 +0200
>> Markus Heiser <markus.heiser@darmarit.de> wrote:
>> 
>>> this is my approach for a more generic way to build only sphinx sub-folders, we
>>> discussed in [1]. The last patch adds a minimal conf.py to the gpu folder, if
>>> you don't want to patch the gpu folder drop it.  
>> 
>> I haven't had a chance to really mess with this yet, but it seems like a
>> reasonable solution. 
> 
> Agreed.
> 
>> Mauro, does it give you what you need?
> 
> Yes. Just tested it here, and it works fine, allowing to build
> everything, just one of the books and the media book with the nitpick
> configuration.
> 
> Acked-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Hi Mauro and Jon,

thanks for testing and ack.

-- Markus --

Re: [PATCH 1/3] doc-rst: generic way to build only sphinx sub-folders

[Jonathan Corbet]

On Mon,  8 Aug 2016 15:14:58 +0200
Markus Heiser <markus.heiser@darmarit.de> wrote:

> Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a
> more generic way to build only a reST sub-folder.
> 
> * control *sub-folders* by environment SPHINXDIRS
> * control *build-theme* by environment SPHINX_CONF
> 
> Folders with a conf.py file, matching $(srctree)/Documentation/*/conf.py
> can be build and distributed *stand-alone*. E.g. to compile only the
> html of 'media' and 'gpu' folder use::
> 
>   make SPHINXDIRS="media gpu" htmldocs
> 
> To use an additional sphinx-build configuration (*build-theme*) set the
> name of the configuration file to SPHINX_CONF. E.g. to compile only the
> html of 'media' with the *nit-picking* build use::
> 
>   make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs
> 
> With this, the Documentation/conf.py is read first and updated with the
> configuration values from the Documentation/media/conf_nitpick.py.

So I went to apply these, but this one, at least, doesn't apply.  Could I
get you to respin the series against current mainline (or docs-next)?

Thanks,

jon

Re: [PATCH 1/3] doc-rst: generic way to build only sphinx sub-folders

[Markus Heiser]

Am 12.08.2016 um 23:20 schrieb Jonathan Corbet <corbet@lwn.net>:

> On Mon,  8 Aug 2016 15:14:58 +0200
> Markus Heiser <markus.heiser@darmarit.de> wrote:
> 
>> Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a
>> more generic way to build only a reST sub-folder.
>> 
> 
> So I went to apply these, but this one, at least, doesn't apply.  Could I
> get you to respin the series against current mainline (or docs-next)?
> 
> Thanks,
> 
> jon

Yes, it was based on Mauro's experimantal mchehab/docs-next. Since
Mauro is on a journey, I merged it on top of your docs-next and send
the *consolidation* patch

  https://www.mail-archive.com/linux-media@vger.kernel.org/msg101262.html

@Mauro: I hope this is OK for you?

-- Markus --