diff mbox

[8/8] v4l: Correct conflicting V4L2 subdev selection API documentation

Message ID 1341075839-18586-8-git-send-email-sakari.ailus@iki.fi (mailing list archive)
State New, archived
Headers show

Commit Message

Sakari Ailus June 30, 2012, 5:03 p.m. UTC
The API reference documents that the KEEP_CONFIG flag tells the
configuration should not be propagated by the driver whereas the interface
documentation (dev-subdev.xml) prohibited any changes to the rest of the
pipeline. Resolve the conflict by changing the API reference to disallow
changes.

Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi>
---
 .../DocBook/media/v4l/selections-common.xml        |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Comments

Sylwester Nawrocki June 30, 2012, 8:29 p.m. UTC | #1
Hi Sakari,

On 06/30/2012 07:03 PM, Sakari Ailus wrote:
> The API reference documents that the KEEP_CONFIG flag tells the
> configuration should not be propagated by the driver whereas the interface
> documentation (dev-subdev.xml) prohibited any changes to the rest of the
> pipeline. Resolve the conflict by changing the API reference to disallow
> changes.
>
> Signed-off-by: Sakari Ailus<sakari.ailus@iki.fi>

Thanks for the patch. It seems much clearer to have the drivers
not propagating the configuration whenever KEEP_CONFIG is set, rather
than relying on not clearly defined additional conditions.

Acked-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/DocBook/media/v4l/selections-common.xml b/Documentation/DocBook/media/v4l/selections-common.xml
index 7cec5c1..007e0c5 100644
--- a/Documentation/DocBook/media/v4l/selections-common.xml
+++ b/Documentation/DocBook/media/v4l/selections-common.xml
@@ -148,7 +148,7 @@ 
 	  <row>
 	    <entry><constant>V4L2_SEL_FLAG_KEEP_CONFIG</constant></entry>
 	    <entry>(1 &lt;&lt; 2)</entry>
-	    <entry>The configuration should not be propagated to any
+	    <entry>The configuration must not be propagated to any
 	    further processing steps. If this flag is not given, the
 	    configuration is propagated inside the subdevice to all
 	    further processing steps.</entry>