diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-09-29 11:23:19 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-15 07:49:44 +0200 |
| commit | b989451b8e0015b8fe2fac0736ab84bf4389fcb0 (patch) | |
| tree | 8454f141c062430abd7be295f29326e3fc723f8e /Documentation/driver-api/libata.rst | |
| parent | docs: kgdb.rst: fix :c:type: usages (diff) | |
| download | linux-b989451b8e0015b8fe2fac0736ab84bf4389fcb0.tar.xz linux-b989451b8e0015b8fe2fac0736ab84bf4389fcb0.zip | |
docs: libata.rst: fix a wrong usage of :c:type: tag
The usage of :c:type: to reference to a struct member is wrong,
as pointed by Sphinx 3:
./Documentation/driver-api/libata.rst:511: WARNING: Unparseable C cross-reference: 'qc->complete_fn'
Invalid C declaration: Expected end of definition. [error at 2]
qc->complete_fn
--^
Instead, let's use :c:expr: for such purpose.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/driver-api/libata.rst')
| -rw-r--r-- | Documentation/driver-api/libata.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/driver-api/libata.rst b/Documentation/driver-api/libata.rst index e2f87b82b074..d477e296bda5 100644 --- a/Documentation/driver-api/libata.rst +++ b/Documentation/driver-api/libata.rst @@ -508,7 +508,7 @@ also complete commands. 2. ATA_QCFLAG_ACTIVE is cleared from qc->flags. -3. :c:func:`qc->complete_fn` callback is invoked. If the return value of the +3. :c:expr:`qc->complete_fn` callback is invoked. If the return value of the callback is not zero. Completion is short circuited and :c:func:`ata_qc_complete` returns. |