Skip to content

Commit f3dfe92

Browse files
torvaldstorvalds
committed
Merge tag 'docs-6.1' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "There's not a huge amount of activity in the docs tree this time around, but a few significant changes even so: - A complete rewriting of the top-level index.rst file, which mostly reflects itself in a redone top page in the HTML-rendered docs. The hope is that the new organization will be a friendlier starting point for both users and developers. - Some math-rendering improvements. - A coding-style.rst update on the use of BUG() and WARN() - A big maintainer-PHP guide update. - Some code-of-conduct updates - More Chinese translation work Plus the usual pile of typo fixes, corrections, and updates" * tag 'docs-6.1' of git://git.lwn.net/linux: (66 commits) checkpatch: warn on usage of VM_BUG_ON() and other BUG variants coding-style.rst: document BUG() and WARN() rules ("do not crash the kernel") Documentation: devres: add missing IO helper Documentation: devres: update IRQ helper Documentation/mm: modify page_referenced to folio_referenced Documentation/CoC: Reflect current CoC interpretation and practices docs/doc-guide: Add documentation on SPHINX_IMGMATH docs: process/5.Posting.rst: clarify use of Reported-by: tag docs, kprobes: Fix the wrong location of Kprobes docs: add a man-pages link to the front page docs: put atomic*.txt and memory-barriers.txt into the core-api book docs: move asm-annotations.rst into core-api docs: remove some index.rst cruft docs: reconfigure the HTML left column docs: Rewrite the front page docs: promote the title of process/index.rst Documentation: devres: add missing SPI helper Documentation: devres: add missing PINCTRL helpers docs: hugetlbpage.rst: fix a typo of hugepage size docs/zh_CN: Add new translation of admin-guide/bootconfig.rst ...
2 parents 890f242 + 69d517e commit f3dfe92

File tree

84 files changed

+2957
-1731
lines changed

Some content is hidden

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

84 files changed

+2957
-1731
lines changed

‎Documentation/ABI/testing/sysfs-bus-bcma

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Date: May 2011
33
KernelVersion: 3.0
44
Contact: Rafał Miłecki <zajec5@gmail.com>
55
Description:
6-
Each BCMA core has it's manufacturer id. See
6+
Each BCMA core has its manufacturer id. See
77
include/linux/bcma/bcma.h for possible values.
88

99
What: /sys/bus/bcma/devices/.../id

‎Documentation/ABI/testing/sysfs-bus-fcoe

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Description: 'FCoE Controller' instances on the fcoe bus.
3131
1) Write interface name to ctlr_create 2) Configure the FCoE
3232
Controller (ctlr_X) 3) Enable the FCoE Controller to begin
3333
discovery and login. The FCoE Controller is destroyed by
34-
writing it's name, i.e. ctlr_X to the ctlr_delete file.
34+
writing its name, i.e. ctlr_X to the ctlr_delete file.
3535

3636
Attributes:
3737

‎Documentation/ABI/testing/sysfs-bus-iio-proximity

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Description:
1818
on the signal from which time of flight measurements are
1919
taken.
2020
The appropriate values to take is dependent on both the
21-
sensor and it's operating environment:
21+
sensor and its operating environment:
2222
* as3935 (0-31 range)
2323
18 = indoors (default)
2424
14 = outdoors

‎Documentation/ABI/testing/sysfs-devices-system-cpu

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ Description: Processor frequency boosting control
296296

297297
This switch controls the boost setting for the whole system.
298298
Boosting allows the CPU and the firmware to run at a frequency
299-
beyond it's nominal limit.
299+
beyond its nominal limit.
300300

301301
More details can be found in
302302
Documentation/admin-guide/pm/cpufreq.rst

‎Documentation/ABI/testing/sysfs-platform-chipidea-usb2

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ What: /sys/bus/platform/devices/ci_hdrc.0/role
22
Date: Mar 2017
33
Contact: Peter Chen <peter.chen@nxp.com>
44
Description:
5-
It returns string "gadget" or "host" when read it, it indicates
6-
current controller role.
5+
When read, it returns string "gadget" or "host", indicating
6+
the current controller role.
77

8-
It will do role switch when write "gadget" or "host" to it.
8+
It will do role switch when "gadget" or "host" is written to it.
99
Only controller at dual-role configuration supports writing.

‎Documentation/ABI/testing/sysfs-power

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Description:
152152
case further investigation is required to determine which
153153
device is causing the problem. Note that genuine RTC clock
154154
values (such as when pm_trace has not been used), can still
155-
match a device and output it's name here.
155+
match a device and output its name here.
156156

157157
What: /sys/power/pm_async
158158
Date: January 2009

‎Documentation/RCU/checklist.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,6 @@ over a rather long period of time, but improvements are always welcome!
486486
So if you need to wait for both an RCU grace period and for
487487
all pre-existing call_rcu() callbacks, you will need to execute
488488
both rcu_barrier() and synchronize_rcu(), if necessary, using
489-
something like workqueues to to execute them concurrently.
489+
something like workqueues to execute them concurrently.
490490

491491
See rcubarrier.rst for more information.

‎Documentation/RCU/lockdep.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ checking of rcu_dereference() primitives:
6161
rcu_access_pointer(p):
6262
Return the value of the pointer and omit all barriers,
6363
but retain the compiler constraints that prevent duplicating
64-
or coalescsing. This is useful when when testing the
64+
or coalescsing. This is useful when testing the
6565
value of the pointer itself, for example, against NULL.
6666

6767
The rcu_dereference_check() check expression can be any boolean

‎Documentation/admin-guide/README.rst

Lines changed: 7 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,6 @@ 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-
Please note that you can still run a.out user programs with this kernel.
266-
267265
- Do a ``make`` to create a compressed kernel image. It is also
268266
possible to do ``make install`` if you have lilo installed to suit the
269267
kernel makefiles, but you may want to check your particular lilo setup first.
@@ -332,85 +330,10 @@ Compiling the kernel
332330
If something goes wrong
333331
-----------------------
334332

335-
- If you have problems that seem to be due to kernel bugs, please check
336-
the file MAINTAINERS to see if there is a particular person associated
337-
with the part of the kernel that you are having trouble with. If there
338-
isn't anyone listed there, then the second best thing is to mail
339-
them to me (torvalds@linux-foundation.org), and possibly to any other
340-
relevant mailing-list or to the newsgroup.
341-
342-
- In all bug-reports, *please* tell what kernel you are talking about,
343-
how to duplicate the problem, and what your setup is (use your common
344-
sense). If the problem is new, tell me so, and if the problem is
345-
old, please try to tell me when you first noticed it.
346-
347-
- If the bug results in a message like::
348-
349-
unable to handle kernel paging request at address C0000010
350-
Oops: 0002
351-
EIP: 0010:XXXXXXXX
352-
eax: xxxxxxxx ebx: xxxxxxxx ecx: xxxxxxxx edx: xxxxxxxx
353-
esi: xxxxxxxx edi: xxxxxxxx ebp: xxxxxxxx
354-
ds: xxxx es: xxxx fs: xxxx gs: xxxx
355-
Pid: xx, process nr: xx
356-
xx xx xx xx xx xx xx xx xx xx
357-
358-
or similar kernel debugging information on your screen or in your
359-
system log, please duplicate it *exactly*. The dump may look
360-
incomprehensible to you, but it does contain information that may
361-
help debugging the problem. The text above the dump is also
362-
important: it tells something about why the kernel dumped code (in
363-
the above example, it's due to a bad kernel pointer). More information
364-
on making sense of the dump is in Documentation/admin-guide/bug-hunting.rst
365-
366-
- If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
367-
as is, otherwise you will have to use the ``ksymoops`` program to make
368-
sense of the dump (but compiling with CONFIG_KALLSYMS is usually preferred).
369-
This utility can be downloaded from
370-
https://www.kernel.org/pub/linux/utils/kernel/ksymoops/ .
371-
Alternatively, you can do the dump lookup by hand:
372-
373-
- In debugging dumps like the above, it helps enormously if you can
374-
look up what the EIP value means. The hex value as such doesn't help
375-
me or anybody else very much: it will depend on your particular
376-
kernel setup. What you should do is take the hex value from the EIP
377-
line (ignore the ``0010:``), and look it up in the kernel namelist to
378-
see which kernel function contains the offending address.
379-
380-
To find out the kernel function name, you'll need to find the system
381-
binary associated with the kernel that exhibited the symptom. This is
382-
the file 'linux/vmlinux'. To extract the namelist and match it against
383-
the EIP from the kernel crash, do::
384-
385-
nm vmlinux | sort | less
386-
387-
This will give you a list of kernel addresses sorted in ascending
388-
order, from which it is simple to find the function that contains the
389-
offending address. Note that the address given by the kernel
390-
debugging messages will not necessarily match exactly with the
391-
function addresses (in fact, that is very unlikely), so you can't
392-
just 'grep' the list: the list will, however, give you the starting
393-
point of each kernel function, so by looking for the function that
394-
has a starting address lower than the one you are searching for but
395-
is followed by a function with a higher address you will find the one
396-
you want. In fact, it may be a good idea to include a bit of
397-
"context" in your problem report, giving a few lines around the
398-
interesting one.
399-
400-
If you for some reason cannot do the above (you have a pre-compiled
401-
kernel image or similar), telling me as much about your setup as
402-
possible will help. Please read
403-
'Documentation/admin-guide/reporting-issues.rst' for details.
404-
405-
- Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
406-
cannot change values or set break points.) To do this, first compile the
407-
kernel with -g; edit arch/x86/Makefile appropriately, then do a ``make
408-
clean``. You'll also need to enable CONFIG_PROC_FS (via ``make config``).
409-
410-
After you've rebooted with the new kernel, do ``gdb vmlinux /proc/kcore``.
411-
You can now use all the usual gdb commands. The command to look up the
412-
point where your system crashed is ``l *0xXXXXXXXX``. (Replace the XXXes
413-
with the EIP value.)
414-
415-
gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
416-
disregards the starting offset for which the kernel is compiled.
333+
If you have problems that seem to be due to kernel bugs, please follow the
334+
instructions at 'Documentation/admin-guide/reporting-issues.rst'.
335+
336+
Hints on understanding kernel bug reports are in
337+
'Documentation/admin-guide/bug-hunting.rst'. More on debugging the kernel
338+
with gdb is in 'Documentation/dev-tools/gdb-kernel-debugging.rst' and
339+
'Documentation/dev-tools/kgdb.rst'.

‎Documentation/admin-guide/hw-vuln/spectre.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,7 @@ kernel command line.
613613
eibrs enhanced IBRS
614614
eibrs,retpoline enhanced IBRS + Retpolines
615615
eibrs,lfence enhanced IBRS + LFENCE
616+
ibrs use IBRS to protect kernel
616617

617618
Not specifying this option is equivalent to
618619
spectre_v2=auto.

0 commit comments

Comments
 (0)