Skip to content

Commit d62aab8

Browse files
lukaszluba-armrafaeljw
authored andcommitted
Documentation: power: include kernel-doc in Energy Model doc
Improve the existing documentation of the Energy Model and add kernel-doc comments. This extends an API description and helps better understanding the usage. Signed-off-by: Lukasz Luba <lukasz.luba@arm.com> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
1 parent ca67408 commit d62aab8

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

Documentation/power/energy-model.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,7 @@ subsystems which use EM might rely on this flag to check if all EM devices use
101101
the same scale. If there are different scales, these subsystems might decide
102102
to: return warning/error, stop working or panic.
103103
See Section 3. for an example of driver implementing this
104-
callback, and kernel/power/energy_model.c for further documentation on this
105-
API.
104+
callback, or Section 2.4 for further documentation on this API
106105

107106

108107
2.3 Accessing performance domains
@@ -123,7 +122,17 @@ em_cpu_energy() API. The estimation is performed assuming that the schedutil
123122
CPUfreq governor is in use in case of CPU device. Currently this calculation is
124123
not provided for other type of devices.
125124

126-
More details about the above APIs can be found in include/linux/energy_model.h.
125+
More details about the above APIs can be found in ``<linux/energy_model.h>``
126+
or in Section 2.4
127+
128+
129+
2.4 Description details of this API
130+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
131+
.. kernel-doc:: include/linux/energy_model.h
132+
:internal:
133+
134+
.. kernel-doc:: kernel/power/energy_model.c
135+
:export:
127136

128137

129138
3. Example driver

0 commit comments

Comments
 (0)