Skip to content

Commit

Permalink
Documentation: soundwire: fix stream.rst markup warnings
Browse files Browse the repository at this point in the history
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: 89634f9 ("Documentation: soundwire: Add more documentation")

Signed-off-by: Randy Dunlap <[email protected]>
Reviewed-by: Takashi Sakamoto <[email protected]>
Tested-by: Takashi Sakamoto <[email protected]>
Signed-off-by: Vinod Koul <[email protected]>
  • Loading branch information
rddunlap authored and vinodkoul committed Sep 17, 2018
1 parent c272a76 commit 502c00d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Documentation/driver-api/soundwire/stream.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ per stream. From ASoC DPCM framework, this stream state maybe linked to
.startup() operation.

.. code-block:: c
int sdw_alloc_stream(char * stream_name);


Expand All @@ -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.

.. code-block:: c
int sdw_stream_add_master(struct sdw_bus * bus,
struct sdw_stream_config * stream_config,
struct sdw_ports_config * ports_config,
Expand Down Expand Up @@ -273,6 +275,7 @@ stream. From ASoC DPCM framework, this stream state is linked to
.prepare() operation.

.. code-block:: c
int sdw_prepare_stream(struct sdw_stream_runtime * stream);


Expand Down Expand Up @@ -302,6 +305,7 @@ stream. From ASoC DPCM framework, this stream state is linked to
.trigger() start operation.

.. code-block:: c
int sdw_enable_stream(struct sdw_stream_runtime * stream);

SDW_STREAM_DISABLED
Expand Down Expand Up @@ -329,6 +333,7 @@ per stream. From ASoC DPCM framework, this stream state is linked to
.trigger() stop operation.

.. code-block:: c
int sdw_disable_stream(struct sdw_stream_runtime * stream);


Expand All @@ -353,6 +358,7 @@ per stream. From ASoC DPCM framework, this stream state is linked to
.trigger() stop operation.

.. code-block:: c
int sdw_deprepare_stream(struct sdw_stream_runtime * stream);


Expand All @@ -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.

.. code-block:: c
int sdw_stream_remove_master(struct sdw_bus * bus,
struct sdw_stream_runtime * stream);
int sdw_stream_remove_slave(struct sdw_slave * slave,
Expand All @@ -389,6 +396,7 @@ stream assigned as part of ALLOCATED state.
In .shutdown() the data structure maintaining stream state are freed up.

.. code-block:: c
void sdw_release_stream(struct sdw_stream_runtime * stream);

Not Supported
Expand Down

0 comments on commit 502c00d

Please sign in to comment.