Skip to content

Commit 30756cc

Browse files
tosch42brgl
authored andcommitted
docs: driver-api: gpio: Fix filename mismatch
The filenames were changed a while ago, but board.rst, consumer.rst and intro.rst still refer to the old names. Fix those references to match the Actual names and avoid possible confusion. Signed-off-by: Tom Schwindl <[email protected]> Signed-off-by: Bartosz Golaszewski <[email protected]>
1 parent 97a4087 commit 30756cc

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

Documentation/driver-api/gpio/board.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document explains how GPIOs can be assigned to given devices and functions.
66

77
Note that it only applies to the new descriptor-based interface. For a
88
description of the deprecated integer-based GPIO interface please refer to
9-
gpio-legacy.txt (actually, there is no real mapping possible with the old
9+
legacy.rst (actually, there is no real mapping possible with the old
1010
interface; you just fetch an integer from somewhere and request the
1111
corresponding GPIO).
1212

Documentation/driver-api/gpio/consumer.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ GPIO Descriptor Consumer Interface
44

55
This document describes the consumer interface of the GPIO framework. Note that
66
it describes the new descriptor-based interface. For a description of the
7-
deprecated integer-based GPIO interface please refer to gpio-legacy.txt.
7+
deprecated integer-based GPIO interface please refer to legacy.rst.
88

99

1010
Guidelines for GPIOs consumers
@@ -78,7 +78,7 @@ whether the line is configured active high or active low (see
7878

7979
The two last flags are used for use cases where open drain is mandatory, such
8080
as I2C: if the line is not already configured as open drain in the mappings
81-
(see board.txt), then open drain will be enforced anyway and a warning will be
81+
(see board.rst), then open drain will be enforced anyway and a warning will be
8282
printed that the board configuration needs to be updated to match the use case.
8383

8484
Both functions return either a valid GPIO descriptor, or an error code checkable
@@ -270,7 +270,7 @@ driven.
270270
The same is applicable for open drain or open source output lines: those do not
271271
actively drive their output high (open drain) or low (open source), they just
272272
switch their output to a high impedance value. The consumer should not need to
273-
care. (For details read about open drain in driver.txt.)
273+
care. (For details read about open drain in driver.rst.)
274274

275275
With this, all the gpiod_set_(array)_value_xxx() functions interpret the
276276
parameter "value" as "asserted" ("1") or "de-asserted" ("0"). The physical line

Documentation/driver-api/gpio/intro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Due to the history of GPIO interfaces in the kernel, there are two different
1414
ways to obtain and use GPIOs:
1515

1616
- The descriptor-based interface is the preferred way to manipulate GPIOs,
17-
and is described by all the files in this directory excepted gpio-legacy.txt.
17+
and is described by all the files in this directory excepted legacy.rst.
1818
- The legacy integer-based interface which is considered deprecated (but still
19-
usable for compatibility reasons) is documented in gpio-legacy.txt.
19+
usable for compatibility reasons) is documented in legacy.rst.
2020

2121
The remainder of this document applies to the new descriptor-based interface.
22-
gpio-legacy.txt contains the same information applied to the legacy
22+
legacy.rst contains the same information applied to the legacy
2323
integer-based interface.
2424

2525

0 commit comments

Comments
 (0)