Commit ee2fe81c authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-6.18' of git://git.lwn.net/linux 

Pull documentation updates from Jonathan Corbet:
 "It has been a relatively busy cycle in docsland, with changes all
  over:

   - Bring the kernel memory-model docs into the Sphinx build in the
     "literal include" mode.

   - Lots of build-infrastructure work, further cleaning up long-term
     kernel-doc technical debt. The sphinx-pre-install tool has been
     converted to Python and updated for current systems.

   - A new tool to detect when documents have been moved and generate
     HTML redirects; this can be used on kernel.org (or any other site
     hosting the rendered docs) to avoid breaking links.

   - Automated processing of the YAML files describing the netlink
     protocol.

   - A significant update of the maintainer's PGP guide.

  ... and a seemingly endless series of typo fixes, build-problem fixes,
  etc"

* tag 'docs-6.18' of git://git.lwn.net/linux: (193 commits)
  Documentation/features: Update feature lists for 6.17-rc7
  docs: remove cdomain.py
  Documentation/process: submitting-patches: fix typo in "were do"
  docs: dev-tools/lkmm: Fix typo of missing file extension
  Documentation: trace: histogram: Convert ftrace docs cross-reference
  Documentation: trace: histogram-design: Wrap introductory note in note:: directive
  Documentation: trace: historgram-design: Separate sched_waking histogram section heading and the following diagram
  Documentation: trace: histogram-design: Trim trailing vertices in diagram explanation text
  Documentation: trace: histogram: Fix histogram trigger subsection number order
  docs: driver-api: fix spelling of "buses".
  Documentation: fbcon: Use admonition directives
  Documentation: fbcon: Reindent 8th step of attach/detach/unload
  Documentation: fbcon: Add boot options and attach/detach/unload section headings
  docs: filesystems: sysfs: add remaining top level sysfs directory descriptions
  docs: filesystems: sysfs: clarify symlink destinations in dev and bus/devices descriptions
  docs: filesystems: sysfs: remove top level sysfs net directory
  docs: maintainer: Fix ambiguous subheading formatting
  docs: kdoc: a few more dump_typedef() tweaks
  docs: kdoc: remove redundant comment stripping in dump_typedef()
  docs: kdoc: remove some dead code in dump_typedef()
  ...
parents 50647a11 99510c32

.pylintrc

+1 −1
Original line number Diff line number Diff line 
[MASTER]

init-hook='import sys; sys.path += ["scripts/lib/kdoc", "scripts/lib/abi"]'
 
init-hook='import sys; sys.path += ["scripts/lib/kdoc", "scripts/lib/abi", "tools/docs/lib"]'

Documentation/.renames.txt

0 → 100644
+1191 −0

File added.

Preview size limit exceeded, changes collapsed.

Documentation/Makefile

+7 −4
Original line number Diff line number Diff line
@@ -60,8 +60,8 @@ ifeq ($(HAVE_LATEXMK),1) 
endif #HAVE_LATEXMK



# Internal variables.

PAPEROPT_a4     = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

PAPEROPT_a4     = -D latex_elements.papersize=a4paper

PAPEROPT_letter = -D latex_elements.papersize=letterpaper

ALLSPHINXOPTS   = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)

ALLSPHINXOPTS   += $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)

ifneq ($(wildcard $(srctree)/.config),)
@@ -87,7 +87,7 @@ loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; 
PYTHONPYCACHEPREFIX ?= $(abspath $(BUILDDIR)/__pycache__)



quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)

      cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \

      cmd_sphinx = \

	PYTHONPYCACHEPREFIX="$(PYTHONPYCACHEPREFIX)" \

	BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(src)/$5/$(SPHINX_CONF)) \

	$(PYTHON3) $(srctree)/scripts/jobserver-exec \
@@ -108,6 +108,9 @@ htmldocs: 
	@$(srctree)/scripts/sphinx-pre-install --version-check

	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))



htmldocs-redirects: $(srctree)/Documentation/.renames.txt

	@tools/docs/gen-redirects.py --output $(BUILDDIR) < $<



# If Rust support is available and .config exists, add rustdoc generated contents.

# If there are any, the errors from this make rustdoc will be displayed but

# won't stop the execution of htmldocs
@@ -171,11 +174,11 @@ refcheckdocs: 


cleandocs:

	$(Q)rm -rf $(BUILDDIR)

	$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean



dochelp:

	@echo  ' Linux kernel internal documentation in different formats from ReST:'

	@echo  '  htmldocs        - HTML'

	@echo  '  htmldocs-redirects - generate HTML redirects for moved pages'

	@echo  '  texinfodocs     - Texinfo'

	@echo  '  infodocs        - Info'

	@echo  '  latexdocs       - LaTeX'

Documentation/PCI/endpoint/pci-endpoint-cfs.rst

+2 −2
Original line number Diff line number Diff line
@@ -86,7 +86,7 @@ The <EPF Device> directory can have a list of symbolic links 
be created by the user to represent the virtual functions that are bound to

the physical function. In the above directory structure <EPF Device 11> is a

physical function and <EPF Device 31> is a virtual function. An EPF device once

it's linked to another EPF device, cannot be linked to a EPC device.

it's linked to another EPF device, cannot be linked to an EPC device.



EPC Device

==========
@@ -108,7 +108,7 @@ entries corresponding to EPC device will be created by the EPC core. 
The <EPC Device> directory will have a list of symbolic links to

<EPF Device>. These symbolic links should be created by the user to

represent the functions present in the endpoint device. Only <EPF Device>

that represents a physical function can be linked to a EPC device.

that represents a physical function can be linked to an EPC device.



The <EPC Device> directory will also have a *start* field. Once

"1" is written to this field, the endpoint device will be ready to

Documentation/PCI/endpoint/pci-endpoint.rst

+3 −3
Original line number Diff line number Diff line
@@ -197,8 +197,8 @@ by the PCI endpoint function driver. 
* pci_epf_register_driver()



   The PCI Endpoint Function driver should implement the following ops:

	 * bind: ops to perform when a EPC device has been bound to EPF device

	 * unbind: ops to perform when a binding has been lost between a EPC

	 * bind: ops to perform when an EPC device has been bound to EPF device

	 * unbind: ops to perform when a binding has been lost between an EPC

	   device and EPF device

	 * add_cfs: optional ops to create function specific configfs

	   attributes
@@ -251,7 +251,7 @@ pci-ep-cfs.c can be used as reference for using these APIs. 
* pci_epf_bind()



   pci_epf_bind() should be invoked when the EPF device has been bound to

   a EPC device.

   an EPC device.



* pci_epf_unbind()