Skip to content

Commit 78b8612

Browse files
puranjaymohanJonathan Corbet
authored andcommitted
Fpga: Documentation: Replace deprecated :c:func: Usage
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> Link: https://lore.kernel.org/r/20200812180224.24810-1-puranjay12@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent a320274 commit 78b8612

4 files changed

Lines changed: 23 additions & 23 deletions

File tree

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

0 commit comments

Comments
 (0)