Documentation: soundwire: Ensure that code is inside the code blocks

Commit Message

Jonathan Neuschäfer March 31, 2019, 10:34 p.m. UTC

The way the document is written now, Sphinx renders empty code blocks
followed by the lines that should be inside them.

Unindent the code-block directives to fix this.

Fixes: 502c00d9c315 ("Documentation: soundwire: fix stream.rst markup warnings")
Signed-off-by: Jonathan Neuschäfer <[e-mail]>
---
 Documentation/driver-api/soundwire/stream.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

--
2.20.1

Comments

Jonathan Corbet April 1, 2019, 9:40 p.m. UTC | #1

On Mon,  1 Apr 2019 00:34:22 +0200
Jonathan Neuschäfer <[e-mail]> wrote:

> The way the document is written now, Sphinx renders empty code blocks
> followed by the lines that should be inside them.
> 
> Unindent the code-block directives to fix this.
> 
> Fixes: 502c00d9c315 ("Documentation: soundwire: fix stream.rst markup warnings")
> Signed-off-by: Jonathan Neuschäfer <[e-mail]>

That definitely makes things better.  Applied, thanks.

I'm going to take out the Fixes tag, though, since the named commit did
not, in fact, introduce that problem.  It's also good to copy authors of
patches named in Fixes tags so they can defend themselves :)

Thanks,

jon

Jonathan Neuschäfer April 1, 2019, 10:52 p.m. UTC | #2

On Mon, Apr 01, 2019 at 03:40:03PM -0600, Jonathan Corbet wrote:
> On Mon,  1 Apr 2019 00:34:22 +0200
> Jonathan Neuschäfer <[e-mail]> wrote:
> 
> > The way the document is written now, Sphinx renders empty code blocks
> > followed by the lines that should be inside them.
> > 
> > Unindent the code-block directives to fix this.
> > 
> > Fixes: 502c00d9c315 ("Documentation: soundwire: fix stream.rst markup warnings")
> > Signed-off-by: Jonathan Neuschäfer <[e-mail]>
> 
> That definitely makes things better.  Applied, thanks.
> 
> I'm going to take out the Fixes tag, though, since the named commit did
> not, in fact, introduce that problem.

Ah, true, the wrong indentation didn't come from that commit.

> It's also good to copy authors of patches named in Fixes tags so they
> can defend themselves :)

Good idea, I'll try to remember that.


Jonathan Neuschäfer

Patch

diff --git a/Documentation/driver-api/soundwire/stream.rst b/Documentation/driver-api/soundwire/stream.rst
index 26a6064503fd..5351bd2f34a8 100644
--- a/Documentation/driver-api/soundwire/stream.rst
+++ b/Documentation/driver-api/soundwire/stream.rst
@@ -201,7 +201,7 @@  Bus implements below API for allocate a stream which needs to be called once
 per stream. From ASoC DPCM framework, this stream state maybe linked to
 .startup() operation.

-  .. code-block:: c
+.. code-block:: c

   int sdw_alloc_stream(char * stream_name);

@@ -228,7 +228,7 @@  the respective Master(s) and Slave(s) associated with stream. These APIs can
 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
+.. code-block:: c

   int sdw_stream_add_master(struct sdw_bus * bus,
 		struct sdw_stream_config * stream_config,
@@ -274,7 +274,7 @@  Bus implements below API for PREPARE state which needs to be called once per
 stream. From ASoC DPCM framework, this stream state is linked to
 .prepare() operation.

-  .. code-block:: c
+.. code-block:: c

   int sdw_prepare_stream(struct sdw_stream_runtime * stream);

@@ -304,7 +304,7 @@  Bus implements below API for ENABLE state which needs to be called once per
 stream. From ASoC DPCM framework, this stream state is linked to
 .trigger() start operation.

-  .. code-block:: c
+.. code-block:: c

   int sdw_enable_stream(struct sdw_stream_runtime * stream);

@@ -332,7 +332,7 @@  Bus implements below API for DISABLED state which needs to be called once
 per stream. From ASoC DPCM framework, this stream state is linked to
 .trigger() stop operation.

-  .. code-block:: c
+.. code-block:: c

   int sdw_disable_stream(struct sdw_stream_runtime * stream);

@@ -357,7 +357,7 @@  Bus implements below API for DEPREPARED state which needs to be called once
 per stream. From ASoC DPCM framework, this stream state is linked to
 .trigger() stop operation.

-  .. code-block:: c
+.. code-block:: c

   int sdw_deprepare_stream(struct sdw_stream_runtime * stream);

@@ -382,7 +382,7 @@  Bus implements below APIs for RELEASE state which needs to be called by
 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
+.. code-block:: c

   int sdw_stream_remove_master(struct sdw_bus * bus,
 		struct sdw_stream_runtime * stream);
@@ -395,7 +395,7 @@  stream assigned as part of ALLOCATED state.

 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);