Changes in Makefile

df60e529 - docs: Makefile: use the new script to check for bad ABI references

Tue, 11 Feb 2025 05:44:06 +0000

docs: Makefile: use the new script to check for bad ABI referencesThe get_abi.pl script was replaced by get_abi.py. Update it at docsmakefile.Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202502110736.ZGWaWsep-lkp@intel.com/Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/20250211054446.1696826-1-mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

ab88c2b3 - tools: ynl: move python code to separate sub-directory

Wed, 08 Jan 2025 13:56:14 +0000

tools: ynl: move python code to separate sub-directoryMove python code to a separate directory so it can bepackaged as a python module. Updates existing referencesin selftests and docs.Also rename ynl-gen-[c|rst] to ynl_gen_[c|rst], avoiddashes as these prevent easy imports for entrypoints.Signed-off-by: Jan Stancek Reviewed-by: Donald Hunter Link: https://patch.msgid.link/a4151bad0e6984e7164d395125ce87fd2e048bf1.1736343575.git.jstancek@redhat.comSigned-off-by: Jakub Kicinski List of files: /linux-6.15/Documentation/Makefile

b1992c37 - kbuild: use $(src) instead of $(srctree)/$(src) for source directory

Sat, 27 Apr 2024 14:55:02 +0000

kbuild: use $(src) instead of $(srctree)/$(src) for source directoryKbuild conventionally uses $(obj)/ for generated files, and $(src)/ forchecked-in source files. It is merely a convention without any functionaldifference. In fact, $(obj) and $(src) are exactly the same, as definedin scripts/Makefile.build: src := $(obj)When the kernel is built in a separate output directory, $(src) doesnot accurately reflect the source directory location. While Kbuildresolves this discrepancy by specifying VPATH=$(srctree) to search forsource files, it does not cover all cases. For example, when adding aheader search path for local headers, -I$(srctree)/$(src) is typicallypassed to the compiler.This introduces inconsistency between upstream and downstream Makefilesbecause $(src) is used instead of $(srctree)/$(src) for the latter.To address this inconsistency, this commit changes the semantics of$(src) so that it always points to the directory in the source tree.Going forward, the variables used in Makefiles will have the followingmeanings: $(obj) - directory in the object tree $(src) - directory in the source tree (changed by this commit) $(objtree) - the top of the kernel object tree $(srctree) - the top of the kernel source treeConsequently, $(srctree)/$(src) in upstream Makefiles need to be replacedwith $(src).Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/Documentation/Makefile

1e596d5e - docs: Detect variable fonts and suggest denylisting them

Sat, 06 Apr 2024 02:04:16 +0000

docs: Detect variable fonts and suggest denylisting themFedora and openSUSE has started deploying "variable font" [1] formatNoto CJK fonts [2, 3]. "CJK" here stands for "Chinese, Japanese,and Korean".Unfortunately, XeTeX/XeLaTeX doesn't understand those fonts forhistorical reasons and builds of translations.pdf end up in errorsif such fonts are present on the build host.To help developers work around the issue, add a script to check thepresence of "variable font" Noto CJK fonts and to emit suggestions.The script is invoked in the error path of "make pdfdocs" so that thesuggestions are made only when a PDF build actually fails.The first suggestion is to denylist those "variable font" files byactivating a per-user and command-local fontconfig setting.For further info and backgrounds, please refer to the header commentof scripts/check-variable-font.sh newly added in this commit.Link: [1] https://en.wikipedia.org/wiki/Variable_fontLink: [2] https://fedoraproject.org/wiki/Changes/Noto_CJK_Variable_FontsLink: [3] https://build.opensuse.org/request/show/1157217Reported-by: Jonathan Corbet Link: https://lore.kernel.org/r/8734tqsrt7.fsf@meer.lwn.net/Reported-by: Иван Иванович Link: https://lore.kernel.org/linux-doc/1708585803.600323099@f111.i.mail.ru/Cc: Randy Dunlap Signed-off-by: Akira Yokosawa Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240406020416.25096-1-akiyks@gmail.com List of files: /linux-6.15/Documentation/Makefile

a304fa1d - docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocs

Tue, 05 Mar 2024 04:23:00 +0000

docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocsCommit f061c9f7d058 ("Documentation: Document each netlink family")added recipes for YAML -> RST conversion.Then commit 7da8bdbf8f5d ("docs: Makefile: Fix make cleandocs bydeleting generated .rst files") made sure those converted .rst filesare cleaned by "make cleandocs".However, they took care of htmldocs build only.If one of other targets such as latexdocs or epubdocs is builtwithout building htmldocs, missing .rst files can cause additionalWARNINGs from sphinx-build as follow: ./Documentation/userspace-api/netlink/specs.rst:18: WARNING: undefined label: 'specs' ./Documentation/userspace-api/netlink/netlink-raw.rst:64: WARNING: unknown document: '../../networking/netlink_spec/rt_link' ./Documentation/userspace-api/netlink/netlink-raw.rst:64: WARNING: unknown document: '../../networking/netlink_spec/tc' ./Documentation/userspace-api/netlink/index.rst:21: WARNING: undefined label: 'specs'Add dependency to $(YNL_INDEX) for other targets and allow any targetsto be built cleanly right after "make cleandocs".Signed-off-by: Akira Yokosawa Cc: stable@vger.kernel.org # v6.7Cc: Thorsten Blum Cc: Breno Leitao Cc: Jakub Kicinski Cc: "David S. Miller" Reviwed-by: Breno Leitao Signed-off-by: Jonathan Corbet Message-ID: List of files: /linux-6.15/Documentation/Makefile

7da8bdbf - docs: Makefile: Fix make cleandocs by deleting generated .rst files

Thu, 08 Feb 2024 14:50:01 +0000

docs: Makefile: Fix make cleandocs by deleting generated .rst filesThe script tools/net/ynl/ynl-gen-rst.py (YNL_TOOL) generates several .rstfiles (YNL_INDEX, YNL_RST_FILES) in Documentation/networking/netlink_spec(YNL_RST_DIR) which are not deleted by make cleandocs.Fix make cleandocs by deleting the generated .rst files.Signed-off-by: Thorsten Blum Reviewed-by: Vegard Nossum Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240208145001.61769-1-thorsten.blum@toblux.com List of files: /linux-6.15/Documentation/Makefile

646158f2 - doc/netlink: Regenerate netlink .rst files if ynl-gen-rst changes

Fri, 15 Dec 2023 09:37:16 +0000

doc/netlink: Regenerate netlink .rst files if ynl-gen-rst changesAdd ynl-gen-rst.py to the dependencies for the netlink .rst files in thedoc Makefile so that the docs get regenerated if the ynl-gen-rst.pyscript is modified. Use $(Q) to honour V=1 in the rules that runynl-gen-rst.pyReviewed-by: Jakub Kicinski Reviewed-by: Breno Leitao Signed-off-by: Donald Hunter Link: https://lore.kernel.org/r/20231215093720.18774-10-donald.hunter@gmail.comSigned-off-by: Jakub Kicinski List of files: /linux-6.15/Documentation/Makefile

f061c9f7 - Documentation: Document each netlink family

Tue, 21 Nov 2023 11:48:31 +0000

Documentation: Document each netlink familyThis is a simple script that parses the Netlink YAML spec files(Documentation/netlink/specs/), and generates RST files to be renderedin the Network -> Netlink Specification documentation page.Create a python script that is invoked during 'make htmldocs', reads theYAML specs input file and generate the correspondent RST file.Create a new Documentation/networking/netlink_spec index page, andreference each Netlink RST file that was processed above in this mainindex.rst file.In case of any exception during the parsing, dump the error and skipthe file.Do not regenerate the RST files if the input files (YAML) were notchanged in-between invocations.Suggested-by: Jakub Kicinski Signed-off-by: Breno Leitao ----Changelog:V3: * Do not regenerate the RST files if the input files were not changed. In order to do it, a few things changed: - Rely on Makefile more to find what changed, and trigger individual file processing - The script parses file by file now (instead of batches) - Create a new option to generate the index fileV2: * Moved the logic from a sphinx extension to a external script * Adjust some formatting as suggested by Donald Hunter and Jakub * Auto generating all the rsts instead of having stubs * Handling error gracefullyReviewed-by: Jakub Kicinski Signed-off-by: David S. Miller List of files: /linux-6.15/Documentation/Makefile

c3521105 - docs: Integrate rustdoc generation into htmldocs

Tue, 18 Jul 2023 15:15:34 +0000

docs: Integrate rustdoc generation into htmldocsChange target `make htmldocs` to combine RST Sphinx and the generation ofRust documentation, when support is available and .config exists.Reviewed-by: Akira Yokosawa Signed-off-by: Carlos Bilbao Reviewed-by: Martin Rodriguez Reboredo Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20230718151534.4067460-3-carlos.bilbao@amd.com List of files: /linux-6.15/Documentation/Makefile

c0d3b831 - kbuild: do not print extra logs for V=2

Thu, 22 Dec 2022 16:25:33 +0000

kbuild: do not print extra logs for V=2Some scripts increase the verbose level when V=1, but others whennot V=0.I think the former is correct because V=2 is not a log level buta switch to print the reason for rebuilding.Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/Documentation/Makefile

1f050e90 - doc: add texinfodocs and infodocs targets

Wed, 16 Nov 2022 19:02:09 +0000

doc: add texinfodocs and infodocs targetsSphinx supports generating Texinfo sources and Info documentation,which can be navigated easily and is convenient to search (via theindexed nodes or anchors, for example).Signed-off-by: Maxim Cournoyer Link: https://lore.kernel.org/r/20221116190210.28407-2-maxim.cournoyer@gmail.comSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

6b22ce00 - docs: Makefile: Add -no-shell-escape option to LATEXOPTS

Thu, 10 Feb 2022 01:26:53 +0000

docs: Makefile: Add -no-shell-escape option to LATEXOPTSIt turns out that LaTeX enables \write18, which allows (some) shellcommands to be executed from the document source, by default. This theoften-seen warning during a pdfdocs build: restricted \write18 enabledThat is a potential security problem and is entirely unnecessary; nothingin the kernel PDF docs build needs that capability. So disable \write18explicitly.Signed-off-by: Akira Yokosawa Link: https://lore.kernel.org/r/519bd2d9-1bee-03e1-eeb4-d9883c18be0c@gmail.comSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

0e805b11 - docs: address some text issues with css/theme support

Sat, 11 Dec 2021 08:57:00 +0000

docs: address some text issues with css/theme supportFix:- overriden ->overridden- some whitespace issues introduced at the css/theme Makefile help.Reported-by: Randy Dunlap Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Randy Dunlap Link: https://lore.kernel.org/r/b0b166025019f7cc4f122bd789c79ba28cc2d29d.1639212812.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

98d614bd - docs: Makefile: use the right path for DOCS_CSS

Sat, 11 Dec 2021 08:56:59 +0000

docs: Makefile: use the right path for DOCS_CSSWhen make is used with O=, the location of the css filewon'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 directoryFix it in a way that both relative and absolute paths will behandled.Reported-by: Randy Dunlap Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap Link: https://lore.kernel.org/r/cea4ff1237ae9a99bc6509ab1bf9c70acd97e265.1639212812.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

135707d3 - docs: allow to pass extra DOCS_CSS themes via make

Tue, 07 Dec 2021 09:53:00 +0000

docs: allow to pass extra DOCS_CSS themes via makeSpecially when the RTD theme is not used, it makes sense toallow specifying extra CSS files via a make variable.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/03d09bf41ad39aa0abfe2ea3c879b09aa3a0948d.1638870323.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

fca7216b - docs: allow selecting a Sphinx theme

Tue, 07 Dec 2021 09:52:59 +0000

docs: allow selecting a Sphinx themeInstead of having RTD as an almost mandatory theme, allow theuser to select other themes via DOCS_THEME environment var.There's a catch, though: as the current theme override logic isdependent of the RTD theme, we need to move the code whichadds the CSS overrides to be inside the RTD theme logic.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/bd20adabfd428fd3cd0e69c2cf146aa354932936.1638870323.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

222a28ed - docs: Makefile: Use CONFIG_SHELL not SHELL

Thu, 17 Jun 2021 22:58:08 +0000

docs: Makefile: Use CONFIG_SHELL not SHELLFix think-o about which variable to find the Kbuild-configured shell.This has accidentally worked due to most shells setting $SHELL bydefault.Fixes: 51e46c7a4007 ("docs, parallelism: Rearrange how jobserver reservations are made")Cc: stable@vger.kernel.orgSigned-off-by: Kees Cook Link: https://lore.kernel.org/r/20210617225808.3907377-1-keescook@chromium.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile

d8d2d382 - kbuild: remove PYTHON variable

Mon, 01 Feb 2021 01:00:24 +0000

kbuild: remove PYTHON variablePython retired in 2020, and some distributions do not provide the'python' command any more.As in commit 51839e29cb59 ("scripts: switch explicitly to Python 3"),we need to use more specific 'python3' to invoke scripts even if theyare written in a way compatible with both Python 2 and 3.This commit removes the variable 'PYTHON', and switches the existingusers to 'PYTHON3'.BTW, PEP 394 (https://www.python.org/dev/peps/pep-0394/) is a helpfulmaterial.Signed-off-by: Masahiro Yamada List of files: /linux-6.15/Documentation/Makefile

75442fb0 - docs: Kconfig/Makefile: add a check for broken ABI files

Fri, 30 Oct 2020 07:40:45 +0000

docs: Kconfig/Makefile: add a check for broken ABI filesThe files under Documentation/ABI should follow the syntaxas defined at Documentation/ABI/README.Allow checking if they're following the syntax by runningthe ABI parser script on COMPILE_TEST.With that, when there's a problem with a file underDocumentation/ABI, it would produce a warning like: Warning: file ./Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats#14: What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_cor' doesn't have a description Warning: file ./Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats#21: What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_fatal' doesn't have a descriptionAcked-by: Jonathan Corbet Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/57a38de85cb4b548857207cf1fc1bf1ee08613c9.1604042072.git.mchehab+huawei@kernel.orgSigned-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/Makefile

d94df02c - docs: Makefile: honor V=0 for docs building

Tue, 27 Oct 2020 10:56:15 +0000

docs: Makefile: honor V=0 for docs buildingReduce the number of displayed mesages when building thedocs with V=0.Suggested-by: Stephen Rothwell Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/478c114a2399b68a18de94ee5f98649304f3903b.1603796153.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/Makefile