OSDN Git Service

[media] ca-set-pid.rst: document struct ca_pid
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 31 Aug 2016 18:59:11 +0000 (15:59 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 9 Sep 2016 12:52:16 +0000 (09:52 -0300)
Add a table describing the fields on this struct, based
on ca.h header.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/uapi/dvb/ca-set-pid.rst

index 8e13ad9..06bdaf4 100644 (file)
@@ -26,7 +26,24 @@ Arguments
   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
 
 ``pid``
-  Undocumented.
+  Pointer to struct :c:type:`ca_pid`.
+
+.. c:type:: ca_pid
+
+.. flat-table:: struct ca_pid
+    :header-rows:  1
+    :stub-columns: 0
+
+    -
+       - unsigned int
+       - pid
+       - Program ID
+
+    -
+       - int
+       - index
+       - PID index. Use -1 to disable.
+
 
 
 Description