linux-kernel - Re: [PATCH v4 12/19] docs: Makefile: document latex/PDF PAPER= parameter

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250912123443.49f15a0e@foz.lan>
Date: Fri, 12 Sep 2025 12:34:43 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jani Nikula <jani.nikula@...ux.intel.com>
Cc: Jonathan Corbet <corbet@....net>, Linux Doc Mailing List
 <linux-doc@...r.kernel.org>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 12/19] docs: Makefile: document latex/PDF PAPER=
 parameter

Em Fri, 12 Sep 2025 12:23:38 +0300
Jani Nikula <jani.nikula@...ux.intel.com> escreveu:

> On Fri, 12 Sep 2025, Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:
> > Em Wed, 10 Sep 2025 13:54:07 +0300
> > Jani Nikula <jani.nikula@...ux.intel.com> escreveu:
> >  
> >> On Thu, 04 Sep 2025, Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:  
> >> > While the build system supports this for a long time, this was
> >> > never documented. Add a documentation for it.
> >> >
> >> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> >> > ---
> >> >  Documentation/Makefile | 2 ++
> >> >  1 file changed, 2 insertions(+)
> >> >
> >> > diff --git a/Documentation/Makefile b/Documentation/Makefile
> >> > index 4736f02b6c9e..0e1d8657a5cc 100644
> >> > --- a/Documentation/Makefile
> >> > +++ b/Documentation/Makefile
> >> > @@ -126,4 +126,6 @@ dochelp:
> >> >  	@echo
> >> >  	@echo  '  make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
> >> >  	@echo
> >> > +	@echo  '  make PAPER={a4|letter} Specifies the paper size used for LaTeX/PDF output.'
> >> > +	@echo
> >> >  	@echo  '  Default location for the generated documents is Documentation/output'    
> >> 
> >> The Sphinx make mode 'sphinx-build -M help' provides all of this and
> >> more...  
> >
> > So? Relying on a help message from sphinx-build would just make
> > our makefile fragile.
> >
> > btw, it didn't work here:
> >
> > 	$ ./sphinx_latest/bin/sphinx-build --version
> > 	sphinx-build 8.2.3
> >
> > 	 $ ./sphinx_latest/bin/sphinx-build  -M help
> > 	Error: at least 3 arguments (builder, source dir, build dir) are required.  
> 
> 'sphinx-build -M help . .'

I'm still missing the point:

	$ ./sphinx_latest/bin/sphinx-build -M help . .
	Sphinx v8.2.3
	Please use `make target' where target is one of
	  html        to make standalone HTML files
	  dirhtml     to make HTML files named index.html in directories
	  singlehtml  to make a single large HTML file
	  pickle      to make pickle files
	  json        to make JSON files
	  htmlhelp    to make HTML files and an HTML help project
	  qthelp      to make HTML files and a qthelp project
	  devhelp     to make HTML files and a Devhelp project
	  epub        to make an epub
	  latex       to make LaTeX files, you can set PAPER=a4 or PAPER=letter
	  latexpdf    to make LaTeX and PDF files (default pdflatex)
	  latexpdfja  to make LaTeX files and run them through platex/dvipdfmx
	  text        to make text files
	  man         to make manual pages
	  texinfo     to make Texinfo files
	  info        to make Texinfo files and run them through makeinfo
	  gettext     to make PO message catalogs
	  changes     to make an overview of all changed/added/deprecated items
	  xml         to make Docutils-native XML files
	  pseudoxml   to make pseudoxml-XML files for display purposes
	  linkcheck   to check all external links for integrity
	  doctest     to run all doctests embedded in the documentation (if enabled)
	  coverage    to run coverage check of the documentation (if enabled)
	  clean       to remove everything in the build directory

Why is it related to this change?

	+	@echo  '  make PAPER={a4|letter} Specifies the paper size used for LaTeX/PDF output.'

Regards,
Mauro