Skip to content

Commit 1f44039

Browse files
committed
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 ...
2 parents 3749bda + 0c8e9b5 commit 1f44039

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+6857
-1607
lines changed

Documentation/ABI/testing/sysfs-bus-vdpa

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
What: /sys/bus/vdpa/drivers_autoprobe
22
Date: March 2020
3-
Contact: [email protected]-foundation.org
3+
Contact: [email protected].dev
44
Description:
55
This file determines whether new devices are immediately bound
66
to a driver after the creation. It initially contains 1, which
@@ -12,7 +12,7 @@ Description:
1212

1313
What: /sys/bus/vdpa/driver_probe
1414
Date: March 2020
15-
Contact: [email protected]-foundation.org
15+
Contact: [email protected].dev
1616
Description:
1717
Writing a device name to this file will cause the kernel binds
1818
devices to a compatible driver.
@@ -22,23 +22,23 @@ Description:
2222

2323
What: /sys/bus/vdpa/drivers/.../bind
2424
Date: March 2020
25-
Contact: [email protected]-foundation.org
25+
Contact: [email protected].dev
2626
Description:
2727
Writing a device name to this file will cause the driver to
2828
attempt to bind to the device. This is useful for overriding
2929
default bindings.
3030

3131
What: /sys/bus/vdpa/drivers/.../unbind
3232
Date: March 2020
33-
Contact: [email protected]-foundation.org
33+
Contact: [email protected].dev
3434
Description:
3535
Writing a device name to this file will cause the driver to
3636
attempt to unbind from the device. This may be useful when
3737
overriding default bindings.
3838

3939
What: /sys/bus/vdpa/devices/.../driver_override
4040
Date: November 2021
41-
Contact: [email protected]-foundation.org
41+
Contact: [email protected].dev
4242
Description:
4343
This file allows the driver for a device to be specified.
4444
When specified, only a driver with a name matching the value

Documentation/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,9 @@ $(YNL_INDEX): $(YNL_RST_FILES)
111111
$(YNL_RST_DIR)/%.rst: $(YNL_YAML_DIR)/%.yaml $(YNL_TOOL)
112112
$(Q)$(YNL_TOOL) -i $< -o $@
113113

114-
htmldocs: $(YNL_INDEX)
114+
htmldocs texinfodocs latexdocs epubdocs xmldocs: $(YNL_INDEX)
115+
116+
htmldocs:
115117
@$(srctree)/scripts/sphinx-pre-install --version-check
116118
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
117119

@@ -176,6 +178,7 @@ refcheckdocs:
176178
$(Q)cd $(srctree);scripts/documentation-file-ref-check
177179

178180
cleandocs:
181+
$(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES)
179182
$(Q)rm -rf $(BUILDDIR)
180183
$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
181184

Documentation/RCU/torture.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Suppose that a previous kvm.sh run left its output in this directory::
318318

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

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

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

Documentation/admin-guide/README.rst

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -262,9 +262,11 @@ Compiling the kernel
262262
- Make sure you have at least gcc 5.1 available.
263263
For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.
264264

265-
- Do a ``make`` to create a compressed kernel image. It is also
266-
possible to do ``make install`` if you have lilo installed to suit the
267-
kernel makefiles, but you may want to check your particular lilo setup first.
265+
- Do a ``make`` to create a compressed kernel image. It is also possible to do
266+
``make install`` if you have lilo installed or if your distribution has an
267+
install script recognised by the kernel's installer. Most popular
268+
distributions will have a recognized install script. You may want to
269+
check your distribution's setup first.
268270

269271
To do the actual install, you have to be root, but none of the normal
270272
build should require that. Don't take the name of root in vain.
@@ -301,32 +303,51 @@ Compiling the kernel
301303
image (e.g. .../linux/arch/x86/boot/bzImage after compilation)
302304
to the place where your regular bootable kernel is found.
303305

304-
- Booting a kernel directly from a floppy without the assistance of a
305-
bootloader such as LILO, is no longer supported.
306-
307-
If you boot Linux from the hard drive, chances are you use LILO, which
308-
uses the kernel image as specified in the file /etc/lilo.conf. The
309-
kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
310-
/boot/bzImage. To use the new kernel, save a copy of the old image
311-
and copy the new image over the old one. Then, you MUST RERUN LILO
312-
to update the loading map! If you don't, you won't be able to boot
313-
the new kernel image.
314-
315-
Reinstalling LILO is usually a matter of running /sbin/lilo.
316-
You may wish to edit /etc/lilo.conf to specify an entry for your
317-
old kernel image (say, /vmlinux.old) in case the new one does not
318-
work. See the LILO docs for more information.
319-
320-
After reinstalling LILO, you should be all set. Shutdown the system,
306+
- Booting a kernel directly from a storage device without the assistance
307+
of a bootloader such as LILO or GRUB, is no longer supported in BIOS
308+
(non-EFI systems). On UEFI/EFI systems, however, you can use EFISTUB
309+
which allows the motherboard to boot directly to the kernel.
310+
On modern workstations and desktops, it's generally recommended to use a
311+
bootloader as difficulties can arise with multiple kernels and secure boot.
312+
For more details on EFISTUB,
313+
see "Documentation/admin-guide/efi-stub.rst".
314+
315+
- It's important to note that as of 2016 LILO (LInux LOader) is no longer in
316+
active development, though as it was extremely popular, it often comes up
317+
in documentation. Popular alternatives include GRUB2, rEFInd, Syslinux,
318+
systemd-boot, or EFISTUB. For various reasons, it's not recommended to use
319+
software that's no longer in active development.
320+
321+
- Chances are your distribution includes an install script and running
322+
``make install`` will be all that's needed. Should that not be the case
323+
you'll have to identify your bootloader and reference its documentation or
324+
configure your EFI.
325+
326+
Legacy LILO Instructions
327+
------------------------
328+
329+
330+
- If you use LILO the kernel images are specified in the file /etc/lilo.conf.
331+
The kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
332+
/boot/bzImage. To use the new kernel, save a copy of the old image and copy
333+
the new image over the old one. Then, you MUST RERUN LILO to update the
334+
loading map! If you don't, you won't be able to boot the new kernel image.
335+
336+
- Reinstalling LILO is usually a matter of running /sbin/lilo. You may wish
337+
to edit /etc/lilo.conf to specify an entry for your old kernel image
338+
(say, /vmlinux.old) in case the new one does not work. See the LILO docs
339+
for more information.
340+
341+
- After reinstalling LILO, you should be all set. Shutdown the system,
321342
reboot, and enjoy!
322343

323-
If you ever need to change the default root device, video mode,
324-
etc. in the kernel image, use your bootloader's boot options
325-
where appropriate. No need to recompile the kernel to change
326-
these parameters.
344+
- If you ever need to change the default root device, video mode, etc. in the
345+
kernel image, use your bootloader's boot options where appropriate. No need
346+
to recompile the kernel to change these parameters.
327347

328348
- Reboot with the new kernel and enjoy.
329349

350+
330351
If something goes wrong
331352
-----------------------
332353

Documentation/admin-guide/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
=================================================
12
The Linux kernel user's and administrator's guide
23
=================================================
34

@@ -37,6 +38,7 @@ problems and bugs in particular.
3738
reporting-issues
3839
reporting-regressions
3940
quickly-build-trimmed-linux
41+
verify-bugs-and-bisect-regressions
4042
bug-hunting
4143
bug-bisect
4244
tainted-kernels

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4668,6 +4668,11 @@
46684668
may be specified.
46694669
Format: <port>,<port>....
46704670

4671+
possible_cpus= [SMP,S390,X86]
4672+
Format: <unsigned int>
4673+
Set the number of possible CPUs, overriding the
4674+
regular discovery mechanisms (such as ACPI/FW, etc).
4675+
46714676
powersave=off [PPC] This option disables power saving features.
46724677
It specifically disables cpuidle and sets the
46734678
platform machine description specific power_save

Documentation/admin-guide/tainted-kernels.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ name of the command ('Comm:') that triggered the event::
3434

3535
You'll find a 'Not tainted: ' there if the kernel was not tainted at the
3636
time of the event; if it was, then it will print 'Tainted: ' and characters
37-
either letters or blanks. In above example it looks like this::
37+
either letters or blanks. In the example above it looks like this::
3838

3939
Tainted: P W O
4040

@@ -52,7 +52,7 @@ At runtime, you can query the tainted state by reading
5252
tainted; any other number indicates the reasons why it is. The easiest way to
5353
decode that number is the script ``tools/debugging/kernel-chktaint``, which your
5454
distribution might ship as part of a package called ``linux-tools`` or
55-
``kernel-tools``; if it doesn't you can download the script from
55+
``kernel-tools``; if it doesn't, you can download the script from
5656
`git.kernel.org <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/tools/debugging/kernel-chktaint>`_
5757
and execute it with ``sh kernel-chktaint``, which would print something like
5858
this on the machine that had the statements in the logs that were quoted earlier::

0 commit comments

Comments
 (0)