Skip to content

Commit b51594d

Browse files
committed
Merge tag 'docs-5.9-3' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet: "A handful of documentation fixes for 5.9" * tag 'docs-5.9-3' of git://git.lwn.net/linux: Documentation: laptops: thinkpad-acpi: fix underline length build warning Documentation: fix typo for abituguru documentation docs: Fix function name trailing double-()s devices.txt: fix typo of "ubd" as "udb" Documentation: add riscv entry in list of existing profiles MAINTAINERS: mention documentation maintainer entry profile Fpga: Documentation: Replace deprecated :c:func: Usage IIO: Documentation: Replace deprecated :c:func: Usage Documentation/locking/locktypes: fix local_locks documentation
2 parents 59815d6 + 92001bc commit b51594d

16 files changed

Lines changed: 57 additions & 55 deletions

File tree

Documentation/RCU/lockdep.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ checking of rcu_dereference() primitives:
4949
is invoked by both RCU-sched readers and updaters.
5050
srcu_dereference_check(p, c):
5151
Use explicit check expression "c" along with
52-
srcu_read_lock_held()(). This is useful in code that
52+
srcu_read_lock_held(). This is useful in code that
5353
is invoked by both SRCU readers and updaters.
5454
rcu_dereference_raw(p):
5555
Don't check. (Use sparingly, if at all.)

Documentation/admin-guide/devices.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1662,7 +1662,7 @@
16621662

16631663
98 block User-mode virtual block device
16641664
0 = /dev/ubda First user-mode block device
1665-
16 = /dev/udbb Second user-mode block device
1665+
16 = /dev/ubdb Second user-mode block device
16661666
...
16671667

16681668
Partitions are handled in the same way as for IDE

Documentation/admin-guide/laptops/thinkpad-acpi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1434,7 +1434,7 @@ on the feature, restricting the viewing angles.
14341434

14351435

14361436
DYTC Lapmode sensor
1437-
------------------
1437+
-------------------
14381438

14391439
sysfs: dytc_lapmode
14401440

Documentation/driver-api/fpga/fpga-bridge.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ API to implement a new FPGA bridge
66

77
* struct :c:type:`fpga_bridge` — The FPGA Bridge structure
88
* struct :c:type:`fpga_bridge_ops` — Low level Bridge driver ops
9-
* :c:func:`devm_fpga_bridge_create()` — Allocate and init a bridge struct
10-
* :c:func:`fpga_bridge_register()` — Register a bridge
11-
* :c:func:`fpga_bridge_unregister()` — Unregister a bridge
9+
* devm_fpga_bridge_create() — Allocate and init a bridge struct
10+
* fpga_bridge_register() — Register a bridge
11+
* fpga_bridge_unregister() — Unregister a bridge
1212

1313
.. kernel-doc:: include/linux/fpga/fpga-bridge.h
1414
:functions: fpga_bridge

Documentation/driver-api/fpga/fpga-mgr.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ API for implementing a new FPGA Manager driver
104104
* ``fpga_mgr_states`` — Values for :c:member:`fpga_manager->state`.
105105
* struct :c:type:`fpga_manager` — the FPGA manager struct
106106
* struct :c:type:`fpga_manager_ops` — Low level FPGA manager driver ops
107-
* :c:func:`devm_fpga_mgr_create` — Allocate and init a manager struct
108-
* :c:func:`fpga_mgr_register` — Register an FPGA manager
109-
* :c:func:`fpga_mgr_unregister` — Unregister an FPGA manager
107+
* devm_fpga_mgr_create() — Allocate and init a manager struct
108+
* fpga_mgr_register() — Register an FPGA manager
109+
* fpga_mgr_unregister() — Unregister an FPGA manager
110110

111111
.. kernel-doc:: include/linux/fpga/fpga-mgr.h
112112
:functions: fpga_mgr_states

Documentation/driver-api/fpga/fpga-programming.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Overview
66

77
The in-kernel API for FPGA programming is a combination of APIs from
88
FPGA manager, bridge, and regions. The actual function used to
9-
trigger FPGA programming is :c:func:`fpga_region_program_fpga()`.
9+
trigger FPGA programming is fpga_region_program_fpga().
1010

11-
:c:func:`fpga_region_program_fpga()` uses functionality supplied by
11+
fpga_region_program_fpga() uses functionality supplied by
1212
the FPGA manager and bridges. It will:
1313

1414
* lock the region's mutex
@@ -20,8 +20,8 @@ the FPGA manager and bridges. It will:
2020
* release the locks
2121

2222
The struct fpga_image_info specifies what FPGA image to program. It is
23-
allocated/freed by :c:func:`fpga_image_info_alloc()` and freed with
24-
:c:func:`fpga_image_info_free()`
23+
allocated/freed by fpga_image_info_alloc() and freed with
24+
fpga_image_info_free()
2525

2626
How to program an FPGA using a region
2727
-------------------------------------
@@ -84,10 +84,10 @@ will generate that list. Here's some sample code of what to do next::
8484
API for programming an FPGA
8585
---------------------------
8686

87-
* :c:func:`fpga_region_program_fpga` — Program an FPGA
88-
* :c:type:`fpga_image_info` — Specifies what FPGA image to program
89-
* :c:func:`fpga_image_info_alloc()` — Allocate an FPGA image info struct
90-
* :c:func:`fpga_image_info_free()` — Free an FPGA image info struct
87+
* fpga_region_program_fpga() — Program an FPGA
88+
* fpga_image_info() — Specifies what FPGA image to program
89+
* fpga_image_info_alloc() — Allocate an FPGA image info struct
90+
* fpga_image_info_free() — Free an FPGA image info struct
9191

9292
.. kernel-doc:: drivers/fpga/fpga-region.c
9393
:functions: fpga_region_program_fpga

Documentation/driver-api/fpga/fpga-region.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,18 @@ API to add a new FPGA region
4646
----------------------------
4747

4848
* struct :c:type:`fpga_region` — The FPGA region struct
49-
* :c:func:`devm_fpga_region_create` — Allocate and init a region struct
50-
* :c:func:`fpga_region_register` — Register an FPGA region
51-
* :c:func:`fpga_region_unregister` — Unregister an FPGA region
49+
* devm_fpga_region_create() — Allocate and init a region struct
50+
* fpga_region_register() — Register an FPGA region
51+
* fpga_region_unregister() — Unregister an FPGA region
5252

5353
The FPGA region's probe function will need to get a reference to the FPGA
5454
Manager it will be using to do the programming. This usually would happen
5555
during the region's probe function.
5656

57-
* :c:func:`fpga_mgr_get` — Get a reference to an FPGA manager, raise ref count
58-
* :c:func:`of_fpga_mgr_get` — Get a reference to an FPGA manager, raise ref count,
57+
* fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count
58+
* of_fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count,
5959
given a device node.
60-
* :c:func:`fpga_mgr_put` — Put an FPGA manager
60+
* fpga_mgr_put() — Put an FPGA manager
6161

6262
The FPGA region will need to specify which bridges to control while programming
6363
the FPGA. The region driver can build a list of bridges during probe time
@@ -66,11 +66,11 @@ the list of bridges to program just before programming
6666
(:c:member:`fpga_region->get_bridges`). The FPGA bridge framework supplies the
6767
following APIs to handle building or tearing down that list.
6868

69-
* :c:func:`fpga_bridge_get_to_list` — Get a ref of an FPGA bridge, add it to a
69+
* fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
7070
list
71-
* :c:func:`of_fpga_bridge_get_to_list` — Get a ref of an FPGA bridge, add it to a
71+
* of_fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
7272
list, given a device node
73-
* :c:func:`fpga_bridges_put` — Given a list of bridges, put them
73+
* fpga_bridges_put() — Given a list of bridges, put them
7474

7575
.. kernel-doc:: include/linux/fpga/fpga-region.h
7676
:functions: fpga_region

Documentation/driver-api/iio/core.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Industrial I/O Devices
1111
----------------------
1212

1313
* struct :c:type:`iio_dev` - industrial I/O device
14-
* :c:func:`iio_device_alloc()` - allocate an :c:type:`iio_dev` from a driver
15-
* :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver
16-
* :c:func:`iio_device_register()` - register a device with the IIO subsystem
17-
* :c:func:`iio_device_unregister()` - unregister a device from the IIO
14+
* iio_device_alloc() - allocate an :c:type:`iio_dev` from a driver
15+
* iio_device_free() - free an :c:type:`iio_dev` from a driver
16+
* iio_device_register() - register a device with the IIO subsystem
17+
* iio_device_unregister() - unregister a device from the IIO
1818
subsystem
1919

2020
An IIO device usually corresponds to a single hardware sensor and it
@@ -34,17 +34,17 @@ A typical IIO driver will register itself as an :doc:`I2C <../i2c>` or
3434

3535
At probe:
3636

37-
1. Call :c:func:`iio_device_alloc()`, which allocates memory for an IIO device.
37+
1. Call iio_device_alloc(), which allocates memory for an IIO device.
3838
2. Initialize IIO device fields with driver specific information (e.g.
3939
device name, device channels).
40-
3. Call :c:func:`iio_device_register()`, this registers the device with the
40+
3. Call iio_device_register(), this registers the device with the
4141
IIO core. After this call the device is ready to accept requests from user
4242
space applications.
4343

4444
At remove, we free the resources allocated in probe in reverse order:
4545

46-
1. :c:func:`iio_device_unregister()`, unregister the device from the IIO core.
47-
2. :c:func:`iio_device_free()`, free the memory allocated for the IIO device.
46+
1. iio_device_unregister(), unregister the device from the IIO core.
47+
2. iio_device_free(), free the memory allocated for the IIO device.
4848

4949
IIO device sysfs interface
5050
==========================

Documentation/hwmon/abituguru-datasheet.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ See below for all known bank addresses, numbers of sensors in that bank,
6868
number of bytes data per sensor and contents/meaning of those bytes.
6969

7070
Although both this document and the kernel driver have kept the sensor
71-
terminoligy for the addressing within a bank this is not 100% correct, in
71+
terminology for the addressing within a bank this is not 100% correct, in
7272
bank 0x24 for example the addressing within the bank selects a PWM output not
7373
a sensor.
7474

@@ -155,7 +155,7 @@ After wider testing of the Linux kernel driver some variants of the uGuru have
155155
turned up which do not hold 0x08 at DATA within 250 reads after writing the
156156
bank address. With these versions this happens quite frequent, using larger
157157
timeouts doesn't help, they just go offline for a second or 2, doing some
158-
internal callibration or whatever. Your code should be prepared to handle
158+
internal calibration or whatever. Your code should be prepared to handle
159159
this and in case of no response in this specific case just goto sleep for a
160160
while and then retry.
161161

@@ -331,6 +331,6 @@ the voltage / clock programming out, I tried reading and only reading banks
331331
0-0x30 with the reading code used for the sensor banks (0x20-0x28) and this
332332
resulted in a _permanent_ reprogramming of the voltages, luckily I had the
333333
sensors part configured so that it would shutdown my system on any out of spec
334-
voltages which proprably safed my computer (after a reboot I managed to
334+
voltages which probably safed my computer (after a reboot I managed to
335335
immediately enter the bios and reload the defaults). This probably means that
336336
the read/write cycle for the non sensor part is different from the sensor part.

Documentation/hwmon/abituguru.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Supported chips:
1717
Note:
1818
The uGuru is a microcontroller with onboard firmware which programs
1919
it to behave as a hwmon IC. There are many different revisions of the
20-
firmware and thus effectivly many different revisions of the uGuru.
20+
firmware and thus effectively many different revisions of the uGuru.
2121
Below is an incomplete list with which revisions are used for which
2222
Motherboards:
2323

@@ -33,7 +33,7 @@ Supported chips:
3333
sensortype (Volt or Temp) for bank1 sensors, for revision 1 uGuru's
3434
this does not always work. For these uGuru's the autodetection can
3535
be overridden with the bank1_types module param. For all 3 known
36-
revison 1 motherboards the correct use of this param is:
36+
revision 1 motherboards the correct use of this param is:
3737
bank1_types=1,1,0,0,0,0,0,2,0,0,0,0,2,0,0,1
3838
You may also need to specify the fan_sensors option for these boards
3939
fan_sensors=5

0 commit comments

Comments
 (0)