redonkable
/
alistair23-linux
1
0
Fork 0
Code Releases Activity

Documentation: soundwire: fix stream.rst markup warnings 

Fix kernel-doc markup warnings in soundwire/stream.rst:

rc4/Documentation/driver-api/soundwire/stream.rst:177: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:203: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:248: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:277: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:304: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:328: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:352: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:364: WARNING: Explicit markup ends without a blank line; unexpected unindent.

Fixes: 89634f99a8 ("Documentation: soundwire: Add more documentation")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Tested-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Vinod Koul <vkoul@kernel.org>
hifive-unleashed-5.1
Randy Dunlap 2018-09-16 17:34:49 -07:00 committed by Vinod Koul
parent c272a766db
commit 502c00d9c3
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/driver-api/soundwire/stream.rst
View File

@ -202,6 +202,7 @@ per stream. From ASoC DPCM framework, this stream state maybe linked to
.startup() operation. .startup() operation.
.. code-block:: c .. code-block:: c
int sdw_alloc_stream(char * stream_name); int sdw_alloc_stream(char * stream_name);
@ -228,6 +229,7 @@ only be invoked once by respective Master(s) and Slave(s). From ASoC DPCM
framework, this stream state is linked to .hw_params() operation. framework, this stream state is linked to .hw_params() operation.
.. code-block:: c .. code-block:: c
int sdw_stream_add_master(struct sdw_bus * bus, int sdw_stream_add_master(struct sdw_bus * bus,
struct sdw_stream_config * stream_config, struct sdw_stream_config * stream_config,
struct sdw_ports_config * ports_config, struct sdw_ports_config * ports_config,
@ -273,6 +275,7 @@ stream. From ASoC DPCM framework, this stream state is linked to
.prepare() operation. .prepare() operation.
.. code-block:: c .. code-block:: c
int sdw_prepare_stream(struct sdw_stream_runtime * stream); int sdw_prepare_stream(struct sdw_stream_runtime * stream);
@ -302,6 +305,7 @@ stream. From ASoC DPCM framework, this stream state is linked to
.trigger() start operation. .trigger() start operation.
.. code-block:: c .. code-block:: c
int sdw_enable_stream(struct sdw_stream_runtime * stream); int sdw_enable_stream(struct sdw_stream_runtime * stream);
SDW_STREAM_DISABLED SDW_STREAM_DISABLED
@ -329,6 +333,7 @@ per stream. From ASoC DPCM framework, this stream state is linked to
.trigger() stop operation. .trigger() stop operation.
.. code-block:: c .. code-block:: c
int sdw_disable_stream(struct sdw_stream_runtime * stream); int sdw_disable_stream(struct sdw_stream_runtime * stream);
@ -353,6 +358,7 @@ per stream. From ASoC DPCM framework, this stream state is linked to
.trigger() stop operation. .trigger() stop operation.
.. code-block:: c .. code-block:: c
int sdw_deprepare_stream(struct sdw_stream_runtime * stream); int sdw_deprepare_stream(struct sdw_stream_runtime * stream);
@ -377,6 +383,7 @@ all the Master(s) and Slave(s) associated with stream. From ASoC DPCM
framework, this stream state is linked to .hw_free() operation. framework, this stream state is linked to .hw_free() operation.
.. code-block:: c .. code-block:: c
int sdw_stream_remove_master(struct sdw_bus * bus, int sdw_stream_remove_master(struct sdw_bus * bus,
struct sdw_stream_runtime * stream); struct sdw_stream_runtime * stream);
int sdw_stream_remove_slave(struct sdw_slave * slave, int sdw_stream_remove_slave(struct sdw_slave * slave,
@ -389,6 +396,7 @@ stream assigned as part of ALLOCATED state.
In .shutdown() the data structure maintaining stream state are freed up. In .shutdown() the data structure maintaining stream state are freed up.
.. code-block:: c .. code-block:: c
void sdw_release_stream(struct sdw_stream_runtime * stream); void sdw_release_stream(struct sdw_stream_runtime * stream);
Not Supported Not Supported