Commit 1f440397 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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

Pull documentation updates from Jonathan Corbet:
 "A moderatly busy cycle for development this time around.

   - Some cleanup of the main index page for easier navigation

   - Rework some of the other top-level pages for better readability
     and, with luck, fewer merge conflicts in the future.

   - Submit-checklist improvements, hopefully the first of many.

   - New Italian translations

   - A fair number of kernel-doc fixes and improvements. We have also
     dropped the recommendation to use an old version of Sphinx.

   - A new document from Thorsten on bisection

  ... and lots of fixes and updates"

* tag 'docs-6.9' of git://git.lwn.net/linux: (54 commits)
  docs: verify/bisect: fixes, finetuning, and support for Arch
  docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocs
  docs: Move ja_JP/howto.rst to ja_JP/process/howto.rst
  docs: submit-checklist: use subheadings
  docs: submit-checklist: structure by category
  docs: new text on bisecting which also covers bug validation
  docs: drop the version constraints for sphinx and dependencies
  docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4
  docs: Restore "smart quotes" for quotes
  docs/zh_CN: accurate translation of "function"
  docs: Include simplified link titles in main index
  docs: Correct formatting of title in admin-guide/index.rst
  docs: kernel_feat.py: fix build error for missing files
  MAINTAINERS: Set the field name for subsystem profile section
  kasan: Add documentation for CONFIG_KASAN_EXTRA_INFO
  Fixed case issue with 'fault-injection' in documentation
  kernel-doc: handle #if in enums as well
  Documentation: update mailing list addresses
  doc: kerneldoc.py: fix indentation
  scripts/kernel-doc: simplify signature printing
  ...
parents 3749bda2 0c8e9b53

Documentation/ABI/testing/sysfs-bus-vdpa

+5 −5
Original line number Diff line number Diff line 
What:		/sys/bus/vdpa/drivers_autoprobe

Date:		March 2020

Contact:	virtualization@lists.linux-foundation.org

Contact:	virtualization@lists.linux.dev

Description:

		This file determines whether new devices are immediately bound

		to a driver after the creation. It initially contains 1, which
@@ -12,7 +12,7 @@ Description: 


What:		/sys/bus/vdpa/driver_probe

Date:		March 2020

Contact:	virtualization@lists.linux-foundation.org

Contact:	virtualization@lists.linux.dev

Description:

		Writing a device name to this file will cause the kernel binds

		devices to a compatible driver.
@@ -22,7 +22,7 @@ Description: 


What:		/sys/bus/vdpa/drivers/.../bind

Date:		March 2020

Contact:	virtualization@lists.linux-foundation.org

Contact:	virtualization@lists.linux.dev

Description:

		Writing a device name to this file will cause the driver to

		attempt to bind to the device. This is useful for overriding
@@ -30,7 +30,7 @@ Description: 


What:		/sys/bus/vdpa/drivers/.../unbind

Date:		March 2020

Contact:	virtualization@lists.linux-foundation.org

Contact:	virtualization@lists.linux.dev

Description:

		Writing a device name to this file will cause the driver to

		attempt to unbind from the device. This may be useful when
@@ -38,7 +38,7 @@ Description: 


What:		/sys/bus/vdpa/devices/.../driver_override

Date:		November 2021

Contact:	virtualization@lists.linux-foundation.org

Contact:	virtualization@lists.linux.dev

Description:

		This file allows the driver for a device to be specified.

		When specified, only a driver with a name matching the value

Documentation/Makefile

+4 −1
Original line number Diff line number Diff line
@@ -111,7 +111,9 @@ $(YNL_INDEX): $(YNL_RST_FILES) 
$(YNL_RST_DIR)/%.rst: $(YNL_YAML_DIR)/%.yaml $(YNL_TOOL)

	$(Q)$(YNL_TOOL) -i $< -o $@



htmldocs: $(YNL_INDEX)

htmldocs texinfodocs latexdocs epubdocs xmldocs: $(YNL_INDEX)



htmldocs:

	@$(srctree)/scripts/sphinx-pre-install --version-check

	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
@@ -176,6 +178,7 @@ refcheckdocs: 
	$(Q)cd $(srctree);scripts/documentation-file-ref-check



cleandocs:

	$(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES)

	$(Q)rm -rf $(BUILDDIR)

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

Documentation/RCU/torture.rst

+1 −1
Original line number Diff line number Diff line
@@ -318,7 +318,7 @@ Suppose that a previous kvm.sh run left its output in this directory:: 


	tools/testing/selftests/rcutorture/res/2022.11.03-11.26.28



Then this run can be re-run without rebuilding as follow:

Then this run can be re-run without rebuilding as follow::



	kvm-again.sh tools/testing/selftests/rcutorture/res/2022.11.03-11.26.28

Documentation/admin-guide/README.rst

+45 −24
Original line number Diff line number Diff line
@@ -262,9 +262,11 @@ Compiling the kernel 
 - Make sure you have at least gcc 5.1 available.

   For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.



 - Do a ``make`` to create a compressed kernel image. It is also

   possible to do ``make install`` if you have lilo installed to suit the

   kernel makefiles, but you may want to check your particular lilo setup first.

 - Do a ``make`` to create a compressed kernel image. It is also possible to do

   ``make install`` if you have lilo installed or if your distribution has an

   install script recognised by the kernel's installer. Most popular

   distributions will have a recognized install script. You may want to

   check your distribution's setup first.



   To do the actual install, you have to be root, but none of the normal

   build should require that. Don't take the name of root in vain.
@@ -301,32 +303,51 @@ Compiling the kernel 
   image (e.g. .../linux/arch/x86/boot/bzImage after compilation)

   to the place where your regular bootable kernel is found.



 - Booting a kernel directly from a floppy without the assistance of a

   bootloader such as LILO, is no longer supported.



   If you boot Linux from the hard drive, chances are you use LILO, which

   uses the kernel image as specified in the file /etc/lilo.conf.  The

   kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or

   /boot/bzImage.  To use the new kernel, save a copy of the old image

   and copy the new image over the old one.  Then, you MUST RERUN LILO

   to update the loading map! If you don't, you won't be able to boot

   the new kernel image.



   Reinstalling LILO is usually a matter of running /sbin/lilo.

   You may wish to edit /etc/lilo.conf to specify an entry for your

   old kernel image (say, /vmlinux.old) in case the new one does not

   work.  See the LILO docs for more information.



   After reinstalling LILO, you should be all set.  Shutdown the system,

 - Booting a kernel directly from a storage device without the assistance

   of a bootloader such as LILO or GRUB, is no longer supported in BIOS

   (non-EFI systems). On UEFI/EFI systems, however, you can use EFISTUB

   which allows the motherboard to boot directly to the kernel.

   On modern workstations and desktops, it's generally recommended to use a

   bootloader as difficulties can arise with multiple kernels and secure boot.

   For more details on EFISTUB,

   see "Documentation/admin-guide/efi-stub.rst".



 - It's important to note that as of 2016 LILO (LInux LOader) is no longer in

   active development, though as it was extremely popular, it often comes up

   in documentation. Popular alternatives include GRUB2, rEFInd, Syslinux,

   systemd-boot, or EFISTUB. For various reasons, it's not recommended to use

   software that's no longer in active development.



 - Chances are your distribution includes an install script and running

   ``make install`` will be all that's needed. Should that not be the case

   you'll have to identify your bootloader and reference its documentation or

   configure your EFI.



Legacy LILO Instructions

------------------------





 - If you use LILO the kernel images are specified in the file /etc/lilo.conf.

   The kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or

   /boot/bzImage. To use the new kernel, save a copy of the old image and copy

   the new image over the old one. Then, you MUST RERUN LILO to update the

   loading map! If you don't, you won't be able to boot the new kernel image.



 - Reinstalling LILO is usually a matter of running /sbin/lilo. You may wish

   to edit /etc/lilo.conf to specify an entry for your old kernel image

   (say, /vmlinux.old) in case the new one does not work. See the LILO docs

   for more information.



 - After reinstalling LILO, you should be all set. Shutdown the system,

   reboot, and enjoy!



   If you ever need to change the default root device, video mode,

   etc. in the kernel image, use your bootloader's boot options

   where appropriate.  No need to recompile the kernel to change

   these parameters.

 - If you ever need to change the default root device, video mode, etc. in the

   kernel image, use your bootloader's boot options where appropriate. No need

   to recompile the kernel to change these parameters.



 - Reboot with the new kernel and enjoy.





If something goes wrong

-----------------------

Documentation/admin-guide/index.rst

+2 −0
Original line number Diff line number Diff line 
=================================================

The Linux kernel user's and administrator's guide

=================================================
@@ -37,6 +38,7 @@ problems and bugs in particular. 
   reporting-issues

   reporting-regressions

   quickly-build-trimmed-linux

   verify-bugs-and-bisect-regressions

   bug-hunting

   bug-bisect

   tainted-kernels