[PATCH 0/2] Fix some issues with DOCS_CSS and DOCS_THEME

[PATCH 0/2] Fix some issues with DOCS_CSS and DOCS_THEME

[Mauro Carvalho Chehab]

Hi Jon,

Randy pointed a couple of issues with the DOCS_CSS and DOCS_THEME patchset.
The two patches in this series address them.

Patch 1 fix the usage of "make O=<dir>".
Patch 2 fix some documentation issues (a typo and whitespace issues).
           
Randy, thanks for reporting those!

Regards,
Mauro

Mauro Carvalho Chehab (2):
  docs: Makefile: use the right path for DOCS_CSS
  docs: address some text issues with css/theme support

 Documentation/Makefile             | 6 +++---
 Documentation/doc-guide/sphinx.rst | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

-- 
2.33.1

[PATCH 1/2] docs: Makefile: use the right path for DOCS_CSS

[Mauro Carvalho Chehab]

When make is used with O=<dir>, the location of the css file
won't be get right:

	$ make DOCS_THEME=nature DOCS_CSS=my_css.css    O=DOCS SPHINXDIRS=x86 -j9 htmldocs
	make[1]: Entering directory '/work/lnx/next/next-2021-1210/DOCS'
	...
	cp: cannot stat 'my_css.css': No such file or directory

Fix it in a way that both relative and absolute paths will be
handled.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1639212812.git.mchehab+huawei@kernel.org/

 Documentation/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 9f0f53db2f10..c9543b63dc6a 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -88,7 +88,7 @@ quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
 	$(abspath $(srctree)/$(src)/$5) \
 	$(abspath $(BUILDDIR)/$3/$4) && \
 	if [ "x$(DOCS_CSS)" != "x" ]; then \
-		cp $(DOCS_CSS) $(BUILDDIR)/$3/_static/; \
+		cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \
 	fi
 
 htmldocs:
-- 
2.33.1

Re: [PATCH 1/2] docs: Makefile: use the right path for DOCS_CSS

[Randy Dunlap]

On 12/11/21 00:56, Mauro Carvalho Chehab wrote:
> When make is used with O=<dir>, the location of the css file
> won't be get right:
> 
> 	$ make DOCS_THEME=nature DOCS_CSS=my_css.css    O=DOCS SPHINXDIRS=x86 -j9 htmldocs
> 	make[1]: Entering directory '/work/lnx/next/next-2021-1210/DOCS'
> 	...
> 	cp: cannot stat 'my_css.css': No such file or directory
> 
> Fix it in a way that both relative and absolute paths will be
> handled.
> 
> Reported-by: Randy Dunlap <rdunlap@infradead.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
> See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1639212812.git.mchehab+huawei@kernel.org/
> 
>  Documentation/Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 9f0f53db2f10..c9543b63dc6a 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -88,7 +88,7 @@ quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
>  	$(abspath $(srctree)/$(src)/$5) \
>  	$(abspath $(BUILDDIR)/$3/$4) && \
>  	if [ "x$(DOCS_CSS)" != "x" ]; then \
> -		cp $(DOCS_CSS) $(BUILDDIR)/$3/_static/; \
> +		cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \
>  	fi
>  
>  htmldocs:
> 

-- 
~Randy

[PATCH 2/2] docs: address some text issues with css/theme support

[Mauro Carvalho Chehab]

Fix:
- overriden ->overridden
- some whitespace issues introduced at the css/theme
  Makefile help.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1639212812.git.mchehab+huawei@kernel.org/

 Documentation/Makefile             | 4 ++--
 Documentation/doc-guide/sphinx.rst | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index c9543b63dc6a..9f4bd42cef18 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -159,8 +159,8 @@ 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 '   make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
+	@echo  '  make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
 	@echo
-	@echo '   make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
+	@echo  '  make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
 	@echo
 	@echo  '  Default location for the generated documents is Documentation/output'
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 7fb6e6168bbb..673cbb769c08 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -147,7 +147,7 @@ By default, the build will try to use the Read the Docs sphinx theme:
 
 If the theme is not available, it will fall-back to the classic one.
 
-The Sphinx theme can be overriden by using the ``DOCS_THEME`` make variable.
+The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
 
 To remove the generated documentation, run ``make cleandocs``.
 
-- 
2.33.1

Re: [PATCH 2/2] docs: address some text issues with css/theme support

[Randy Dunlap]

On 12/11/21 00:57, Mauro Carvalho Chehab wrote:
> Fix:
> - overriden ->overridden
> - some whitespace issues introduced at the css/theme
>   Makefile help.
> 
> Reported-by: Randy Dunlap <rdunlap@infradead.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
> See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1639212812.git.mchehab+huawei@kernel.org/
> 
>  Documentation/Makefile             | 4 ++--
>  Documentation/doc-guide/sphinx.rst | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index c9543b63dc6a..9f4bd42cef18 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -159,8 +159,8 @@ 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 '   make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
> +	@echo  '  make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
>  	@echo
> -	@echo '   make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
> +	@echo  '  make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
>  	@echo
>  	@echo  '  Default location for the generated documents is Documentation/output'
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index 7fb6e6168bbb..673cbb769c08 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -147,7 +147,7 @@ By default, the build will try to use the Read the Docs sphinx theme:
>  
>  If the theme is not available, it will fall-back to the classic one.
>  
> -The Sphinx theme can be overriden by using the ``DOCS_THEME`` make variable.
> +The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
>  
>  To remove the generated documentation, run ``make cleandocs``.
>  
> 

-- 
~Randy

Re: [PATCH 0/2] Fix some issues with DOCS_CSS and DOCS_THEME

[Jonathan Corbet]

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> Hi Jon,
>
> Randy pointed a couple of issues with the DOCS_CSS and DOCS_THEME patchset.
> The two patches in this series address them.
>
> Patch 1 fix the usage of "make O=<dir>".
> Patch 2 fix some documentation issues (a typo and whitespace issues).
>            
> Randy, thanks for reporting those!
>
> Regards,
> Mauro
>
> Mauro Carvalho Chehab (2):
>   docs: Makefile: use the right path for DOCS_CSS
>   docs: address some text issues with css/theme support
>
>  Documentation/Makefile             | 6 +++---
>  Documentation/doc-guide/sphinx.rst | 2 +-
>  2 files changed, 4 insertions(+), 4 deletions(-)

Set applied, thanks.

jon