Mauro Carvalho Chehab
be1038846b
docs: soundwire: locking: fix tags for a code-block
...
There's an ascii artwork at Example 1 whose code-block is not properly
idented, causing those warnings.
Documentation/driver-api/soundwire/locking.rst:50: WARNING: Inconsistent literal block quoting.
Documentation/driver-api/soundwire/locking.rst:51: WARNING: Line block ends without a blank line.
Documentation/driver-api/soundwire/locking.rst:55: WARNING: Inline substitution_reference start-string without end-string.
Documentation/driver-api/soundwire/locking.rst:56: WARNING: Line block ends without a blank line.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org >
Acked-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2019-06-04 20:48:45 +05:30
Jonathan Neuschäfer
491a3e883c
Documentation: soundwire: Ensure that code is inside the code blocks
...
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.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2019-04-02 07:59:56 -06:00
Randy Dunlap
502c00d9c3
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: 89634f99a8rdunlap@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 >
2018-09-17 09:12:36 -07:00
Sanyog Kale
8cf3f9cfd9
Documentation: soundwire: Add documentation for multi link
...
Add example and documentation to describe multi link streams
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Sanyog Kale <sanyog.r.kale@intel.com >
Signed-off-by: Shreyas NC <shreyas.nc@intel.com >
Acked-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2018-08-27 09:49:48 +05:30
Sanyog Kale
89634f99a8
Documentation: soundwire: Add more documentation
...
This adds documentation for error handling, locking and streams.
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Sanyog Kale <sanyog.r.kale@intel.com >
Signed-off-by: Shreyas NC <shreyas.nc@intel.com >
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2018-05-11 21:47:02 +05:30
Sanyog Kale
8ecf4264ef
Documentation: Add SoundWire summary
...
SoundWire is a new Linux bus which implements a new MIPI bus protocol
'SoundWire'. The summary of SoundWire bus and API is documented in the
'summary' file.
Signed-off-by: Sanyog Kale <sanyog.r.kale@intel.com >
Signed-off-by: Hardik T Shah <hardik.t.shah@intel.com >
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com >
Acked-By: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Reviewed-by: Takashi Iwai <tiwai@suse.de >
Signed-off-by: Vinod Koul <vinod.koul@intel.com >
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2017-12-19 11:14:30 +01:00
