Skip to content

Commit a3f53e8

Browse files
committed
Merge tag 'docs-5.13-2' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet: "A few late-arriving documentation fixes, including some oprofile cleanup, a kernel-doc fix, some regression-reporting updates, and the usual minor fixes" * tag 'docs-5.13-2' of git://git.lwn.net/linux: Enlisted oprofile version line removed oprofiled version output line removed from the list Removed the oprofiled version option docs: reporting-issues.rst: CC subsystem and maintainers on regressions docs: correct URL to bios and kernel developer's guide docs/core-api: Consistent code style docs/zh_CN: Adjust order and content of zh_CN/index.rst Documentation: input: joydev file corrections docs: Fix typo in Documentation/x86/x86_64/5level-paging.rst kernel-doc: Add support for __deprecated
2 parents 8404c9f + 7fc4607 commit a3f53e8

File tree

11 files changed

+225
-68
lines changed

11 files changed

+225
-68
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Description: Disable L3 cache indices
285285

286286
All AMD processors with L3 caches provide this functionality.
287287
For details, see BKDGs at
288-
http://developer.amd.com/documentation/guides/Pages/default.aspx
288+
https://www.amd.com/en/support/tech-docs?keyword=bios+kernel
289289

290290

291291
What: /sys/devices/system/cpu/cpufreq/boost

Documentation/admin-guide/reporting-issues.rst

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ longterm series? One still supported? Then search the `LKML
2424
you don't find any, install `the latest release from that series
2525
<https://kernel.org/>`_. If it still shows the issue, report it to the stable
2626
mailing list ([email protected]) and CC the regressions list
27-
27+
([email protected]); ideally also CC the maintainer and the mailing
28+
list for the subsystem in question.
2829

2930
In all other cases try your best guess which kernel part might be causing the
3031
issue. Check the :ref:`MAINTAINERS <maintainers>` file for how its developers
@@ -48,8 +49,9 @@ before the issue occurs.
4849
If you are facing multiple issues with the Linux kernel at once, report each
4950
separately. While writing your report, include all information relevant to the
5051
issue, like the kernel and the distro used. In case of a regression, CC the
51-
regressions mailing list ([email protected]) to your report; also try
52-
to include the commit-id of the change causing it, which a bisection can find.
52+
regressions mailing list ([email protected]) to your report. Also try
53+
to pin-point the culprit with a bisection; if you succeed, include its
54+
commit-id and CC everyone in the sign-off-by chain.
5355

5456
Once the report is out, answer any questions that come up and help where you
5557
can. That includes keeping the ball rolling by occasionally retesting with newer
@@ -198,10 +200,11 @@ report them:
198200

199201
* Send a short problem report to the Linux stable mailing list
200202
([email protected]) and CC the Linux regressions mailing list
201-
([email protected]). Roughly describe the issue and ideally
202-
explain how to reproduce it. Mention the first version that shows the
203-
problem and the last version that's working fine. Then wait for further
204-
instructions.
203+
([email protected]); if you suspect the cause in a particular
204+
subsystem, CC its maintainer and its mailing list. Roughly describe the
205+
issue and ideally explain how to reproduce it. Mention the first version
206+
that shows the problem and the last version that's working fine. Then
207+
wait for further instructions.
205208

206209
The reference section below explains each of these steps in more detail.
207210

@@ -768,7 +771,9 @@ regular internet search engine and add something like
768771
the results to the archives at that URL.
769772

770773
It's also wise to check the internet, LKML and maybe bugzilla.kernel.org again
771-
at this point.
774+
at this point. If your report needs to be filed in a bug tracker, you may want
775+
to check the mailing list archives for the subsystem as well, as someone might
776+
have reported it only there.
772777

773778
For details how to search and what to do if you find matching reports see
774779
"Search for existing reports, first run" above.
@@ -1249,9 +1254,10 @@ and the oldest where the issue occurs (say 5.8-rc1).
12491254

12501255
When sending the report by mail, CC the Linux regressions mailing list
12511256
([email protected]). In case the report needs to be filed to some web
1252-
tracker, proceed to do so; once filed, forward the report by mail to the
1253-
regressions list. Make sure to inline the forwarded report, hence do not attach
1254-
it. Also add a short note at the top where you mention the URL to the ticket.
1257+
tracker, proceed to do so. Once filed, forward the report by mail to the
1258+
regressions list; CC the maintainer and the mailing list for the subsystem in
1259+
question. Make sure to inline the forwarded report, hence do not attach it.
1260+
Also add a short note at the top where you mention the URL to the ticket.
12551261

12561262
When mailing or forwarding the report, in case of a successful bisection add the
12571263
author of the culprit to the recipients; also CC everyone in the signed-off-by
@@ -1536,17 +1542,20 @@ Report the regression
15361542

15371543
*Send a short problem report to the Linux stable mailing list
15381544
([email protected]) and CC the Linux regressions mailing list
1539-
([email protected]). Roughly describe the issue and ideally
1540-
explain how to reproduce it. Mention the first version that shows the
1541-
problem and the last version that's working fine. Then wait for further
1542-
instructions.*
1545+
([email protected]); if you suspect the cause in a particular
1546+
subsystem, CC its maintainer and its mailing list. Roughly describe the
1547+
issue and ideally explain how to reproduce it. Mention the first version
1548+
that shows the problem and the last version that's working fine. Then
1549+
wait for further instructions.*
15431550

15441551
When reporting a regression that happens within a stable or longterm kernel
15451552
line (say when updating from 5.10.4 to 5.10.5) a brief report is enough for
1546-
the start to get the issue reported quickly. Hence a rough description is all
1547-
it takes.
1553+
the start to get the issue reported quickly. Hence a rough description to the
1554+
stable and regressions mailing list is all it takes; but in case you suspect
1555+
the cause in a particular subsystem, CC its maintainers and its mailing list
1556+
as well, because that will speed things up.
15481557

1549-
But note, it helps developers a great deal if you can specify the exact version
1558+
And note, it helps developers a great deal if you can specify the exact version
15501559
that introduced the problem. Hence if possible within a reasonable time frame,
15511560
try to find that version using vanilla kernels. Lets assume something broke when
15521561
your distributor released a update from Linux kernel 5.10.5 to 5.10.8. Then as
@@ -1563,7 +1572,9 @@ pinpoint the exact change that causes the issue (which then can easily get
15631572
reverted to fix the issue quickly). Hence consider to do a proper bisection
15641573
right away if time permits. See the section 'Special care for regressions' and
15651574
the document 'Documentation/admin-guide/bug-bisect.rst' for details how to
1566-
perform one.
1575+
perform one. In case of a successful bisection add the author of the culprit to
1576+
the recipients; also CC everyone in the signed-off-by chain, which you find at
1577+
the end of its commit message.
15671578

15681579

15691580
Reference for "Reporting issues only occurring in older kernel version lines"

Documentation/core-api/symbol-namespaces.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ exporting of kernel symbols to the kernel symbol table, variants of these are
4343
available to export symbols into a certain namespace: EXPORT_SYMBOL_NS() and
4444
EXPORT_SYMBOL_NS_GPL(). They take one additional argument: the namespace.
4545
Please note that due to macro expansion that argument needs to be a
46-
preprocessor symbol. E.g. to export the symbol `usb_stor_suspend` into the
47-
namespace `USB_STORAGE`, use::
46+
preprocessor symbol. E.g. to export the symbol ``usb_stor_suspend`` into the
47+
namespace ``USB_STORAGE``, use::
4848

4949
EXPORT_SYMBOL_NS(usb_stor_suspend, USB_STORAGE);
5050

51-
The corresponding ksymtab entry struct `kernel_symbol` will have the member
52-
`namespace` set accordingly. A symbol that is exported without a namespace will
53-
refer to `NULL`. There is no default namespace if none is defined. `modpost`
51+
The corresponding ksymtab entry struct ``kernel_symbol`` will have the member
52+
``namespace`` set accordingly. A symbol that is exported without a namespace will
53+
refer to ``NULL``. There is no default namespace if none is defined. ``modpost``
5454
and kernel/module.c make use the namespace at build time or module load time,
5555
respectively.
5656

@@ -64,7 +64,7 @@ and EXPORT_SYMBOL_GPL() macro expansions that do not specify a namespace.
6464

6565
There are multiple ways of specifying this define and it depends on the
6666
subsystem and the maintainer's preference, which one to use. The first option
67-
is to define the default namespace in the `Makefile` of the subsystem. E.g. to
67+
is to define the default namespace in the ``Makefile`` of the subsystem. E.g. to
6868
export all symbols defined in usb-common into the namespace USB_COMMON, add a
6969
line like this to drivers/usb/common/Makefile::
7070

@@ -96,7 +96,7 @@ using a statement like::
9696

9797
MODULE_IMPORT_NS(USB_STORAGE);
9898

99-
This will create a `modinfo` tag in the module for each imported namespace.
99+
This will create a ``modinfo`` tag in the module for each imported namespace.
100100
This has the side effect, that the imported namespaces of a module can be
101101
inspected with modinfo::
102102

@@ -113,7 +113,7 @@ metadata definitions like MODULE_AUTHOR() or MODULE_LICENSE(). Refer to section
113113
4. Loading Modules that use namespaced Symbols
114114
==============================================
115115

116-
At module loading time (e.g. `insmod`), the kernel will check each symbol
116+
At module loading time (e.g. ``insmod``), the kernel will check each symbol
117117
referenced from the module for its availability and whether the namespace it
118118
might be exported to has been imported by the module. The default behaviour of
119119
the kernel is to reject loading modules that don't specify sufficient imports.
@@ -138,19 +138,19 @@ missing imports. Fixing missing imports can be done with::
138138
A typical scenario for module authors would be::
139139

140140
- write code that depends on a symbol from a not imported namespace
141-
- `make`
141+
- ``make``
142142
- notice the warning of modpost telling about a missing import
143-
- run `make nsdeps` to add the import to the correct code location
143+
- run ``make nsdeps`` to add the import to the correct code location
144144

145145
For subsystem maintainers introducing a namespace, the steps are very similar.
146-
Again, `make nsdeps` will eventually add the missing namespace imports for
146+
Again, ``make nsdeps`` will eventually add the missing namespace imports for
147147
in-tree modules::
148148

149149
- move or add symbols to a namespace (e.g. with EXPORT_SYMBOL_NS())
150-
- `make` (preferably with an allmodconfig to cover all in-kernel
150+
- ``make`` (preferably with an allmodconfig to cover all in-kernel
151151
modules)
152152
- notice the warning of modpost telling about a missing import
153-
- run `make nsdeps` to add the import to the correct code location
153+
- run ``make nsdeps`` to add the import to the correct code location
154154

155155
You can also run nsdeps for external module builds. A typical usage is::
156156

Documentation/input/joydev/joystick-api.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The possible values of ``type`` are::
7171
#define JS_EVENT_INIT 0x80 /* initial state of device */
7272

7373
As mentioned above, the driver will issue synthetic JS_EVENT_INIT ORed
74-
events on open. That is, if it's issuing a INIT BUTTON event, the
74+
events on open. That is, if it's issuing an INIT BUTTON event, the
7575
current type value will be::
7676

7777
int type = JS_EVENT_BUTTON | JS_EVENT_INIT; /* 0x81 */
@@ -100,8 +100,8 @@ is, you have both an axis 0 and a button 0). Generally,
100100
=============== =======
101101

102102
Hats vary from one joystick type to another. Some can be moved in 8
103-
directions, some only in 4, The driver, however, always reports a hat as two
104-
independent axis, even if the hardware doesn't allow independent movement.
103+
directions, some only in 4. The driver, however, always reports a hat as two
104+
independent axes, even if the hardware doesn't allow independent movement.
105105

106106

107107
js_event.value
@@ -188,10 +188,10 @@ One reason for emptying the queue is that if it gets full you'll start
188188
missing events since the queue is finite, and older events will get
189189
overwritten.
190190

191-
The other reason is that you want to know all what happened, and not
191+
The other reason is that you want to know all that happened, and not
192192
delay the processing till later.
193193

194-
Why can get the queue full? Because you don't empty the queue as
194+
Why can the queue get full? Because you don't empty the queue as
195195
mentioned, or because too much time elapses from one read to another
196196
and too many events to store in the queue get generated. Note that
197197
high system load may contribute to space those reads even more.
@@ -277,7 +277,7 @@ to be in the stable part of the API, and therefore may change without
277277
warning in following releases of the driver.
278278

279279
Both JSIOCSCORR and JSIOCGCORR expect &js_corr to be able to hold
280-
information for all axis. That is, struct js_corr corr[MAX_AXIS];
280+
information for all axes. That is, struct js_corr corr[MAX_AXIS];
281281

282282
struct js_corr is defined as::
283283

@@ -328,7 +328,7 @@ To test the state of the buttons,
328328
second_button_state = js.buttons & 2;
329329

330330
The axis values do not have a defined range in the original 0.x driver,
331-
except for that the values are non-negative. The 1.2.8+ drivers use a
331+
except that the values are non-negative. The 1.2.8+ drivers use a
332332
fixed range for reporting the values, 1 being the minimum, 128 the
333333
center, and 255 maximum value.
334334

Documentation/input/joydev/joystick.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -133,15 +133,15 @@ And add a line to your rc script executing that file::
133133
This way, after the next reboot your joystick will remain calibrated. You
134134
can also add the ``jscal -p`` line to your shutdown script.
135135

136-
HW specific driver information
137-
==============================
136+
Hardware-specific driver information
137+
====================================
138138

139139
In this section each of the separate hardware specific drivers is described.
140140

141141
Analog joysticks
142142
----------------
143143

144-
The analog.c uses the standard analog inputs of the gameport, and thus
144+
The analog.c driver uses the standard analog inputs of the gameport, and thus
145145
supports all standard joysticks and gamepads. It uses a very advanced
146146
routine for this, allowing for data precision that can't be found on any
147147
other system.
@@ -266,7 +266,7 @@ to:
266266
* Logitech WingMan Extreme Digital 3D
267267

268268
ADI devices are autodetected, and the driver supports up to two (any
269-
combination of) devices on a single gameport, using an Y-cable or chained
269+
combination of) devices on a single gameport, using a Y-cable or chained
270270
together.
271271

272272
Logitech WingMan Joystick, Logitech WingMan Attack, Logitech WingMan
@@ -288,7 +288,7 @@ supports:
288288
* Gravis Xterminator DualControl
289289

290290
All these devices are autodetected, and you can even use any combination
291-
of up to two of these pads either chained together or using an Y-cable on a
291+
of up to two of these pads either chained together or using a Y-cable on a
292292
single gameport.
293293

294294
GrIP MultiPort isn't supported yet. Gravis Stinger is a serial device and is
@@ -311,7 +311,7 @@ allow connecting analog joysticks to them, you'll need to load the analog
311311
driver as well to handle the attached joysticks.
312312

313313
The trackball should work with USB mousedev module as a normal mouse. See
314-
the USB documentation for how to setup an USB mouse.
314+
the USB documentation for how to setup a USB mouse.
315315

316316
ThrustMaster DirectConnect (BSP)
317317
--------------------------------
@@ -332,7 +332,7 @@ If you have one of these, contact me.
332332

333333
TMDC devices are autodetected, and thus no parameters to the module
334334
are needed. Up to two TMDC devices can be connected to one gameport, using
335-
an Y-cable.
335+
a Y-cable.
336336

337337
Creative Labs Blaster
338338
---------------------
@@ -342,7 +342,7 @@ the:
342342

343343
* Creative Blaster GamePad Cobra
344344

345-
Up to two of these can be used on a single gameport, using an Y-cable.
345+
Up to two of these can be used on a single gameport, using a Y-cable.
346346

347347
Genius Digital joysticks
348348
------------------------
@@ -381,7 +381,7 @@ card, 16 in case you have two in your system.
381381
Trident 4DWave / Aureal Vortex
382382
------------------------------
383383

384-
Soundcards with a Trident 4DWave DX/NX or Aureal Vortex/Vortex2 chipsets
384+
Soundcards with a Trident 4DWave DX/NX or Aureal Vortex/Vortex2 chipset
385385
provide an "Enhanced Game Port" mode where the soundcard handles polling the
386386
joystick. This mode is supported by the pcigame.c module. Once loaded the
387387
analog driver can use the enhanced features of these gameports..
@@ -454,7 +454,7 @@ Devices currently supported by spaceball.c are:
454454
* SpaceTec SpaceBall 4000 FLX
455455

456456
In addition to having the spaceorb/spaceball and serport modules in the
457-
kernel, you also need to attach a serial port to it. to do that, run the
457+
kernel, you also need to attach a serial port to it. To do that, run the
458458
inputattach program::
459459

460460
inputattach --spaceorb /dev/tts/x &
@@ -466,7 +466,7 @@ or::
466466
where /dev/tts/x is the serial port which the device is connected to. After
467467
doing this, the device will be reported and will start working.
468468

469-
There is one caveat with the SpaceOrb. The button #6, the on the bottom
469+
There is one caveat with the SpaceOrb. The button #6, the one on the bottom
470470
side of the orb, although reported as an ordinary button, causes internal
471471
recentering of the spaceorb, moving the zero point to the position in which
472472
the ball is at the moment of pressing the button. So, think first before
@@ -500,7 +500,7 @@ joy-magellan module. It currently supports only the:
500500
* Magellan 3D
501501
* Space Mouse
502502

503-
models, the additional buttons on the 'Plus' versions are not supported yet.
503+
models; the additional buttons on the 'Plus' versions are not supported yet.
504504

505505
To use it, you need to attach the serial port to the driver using the::
506506

@@ -575,7 +575,7 @@ FAQ
575575
:A: The device files don't exist. Create them (see section 2.2).
576576

577577
:Q: Is it possible to connect my old Atari/Commodore/Amiga/console joystick
578-
or pad that uses a 9-pin D-type cannon connector to the serial port of my
578+
or pad that uses a 9-pin D-type Cannon connector to the serial port of my
579579
PC?
580580
:A: Yes, it is possible, but it'll burn your serial port or the pad. It
581581
won't work, of course.

Documentation/process/changes.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ quota-tools 3.09 quota -V
4848
PPP 2.4.0 pppd --version
4949
nfs-utils 1.0.5 showmount --version
5050
procps 3.2.0 ps --version
51-
oprofile 0.9 oprofiled --version
5251
udev 081 udevd --version
5352
grub 0.93 grub --version || grub-install --version
5453
mcelog 0.6 mcelog --version

Documentation/translations/it_IT/process/changes.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ quota-tools 3.09 quota -V
5151
PPP 2.4.0 pppd --version
5252
nfs-utils 1.0.5 showmount --version
5353
procps 3.2.0 ps --version
54-
oprofile 0.9 oprofiled --version
5554
udev 081 udevd --version
5655
grub 0.93 grub --version || grub-install --version
5756
mcelog 0.6 mcelog --version

0 commit comments

Comments
 (0)