tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
[media] DocBook: Change format for enum dmx_output documentation
Use a table for the Demux output. No new information added
here. They were all merged inside the table.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
+47
-29
+7
-6
Documentation/DocBook/media/Makefile
+7
-6
Documentation/DocBook/media/Makefile
···
88
88
89
89
ENUM_DEFS = \
90
90
$(shell perl -e 'open IN,"cat @ARGV| cpp -fpreprocessed |"; while (<IN>) { if ($$enum) {print "$$1\n" if (/\s*([A-Z]\S+)\b/); } $$enum = 0 if ($$enum && /^\}/); $$enum = 1 if(/^\s*enum\s/); }; close IN;' \
91
-
$(srctree)/include/uapi/linux/dvb/audio.h \
92
-
$(srctree)/include/uapi/linux/dvb/ca.h \
93
91
$(srctree)/include/uapi/linux/dvb/dmx.h \
94
-
$(srctree)/include/uapi/linux/dvb/frontend.h \
95
-
$(srctree)/include/uapi/linux/dvb/net.h \
96
-
$(srctree)/include/uapi/linux/dvb/video.h)
92
+
$(srctree)/include/uapi/linux/dvb/frontend.h)
97
93
98
94
STRUCTS = \
99
95
$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/uapi/linux/videodev2.h) \
···
247
251
@( \
248
252
echo "<programlisting>") > $@
249
253
@( \
254
+
for ident in $(ENUM_DEFS) ; do \
255
+
entity=`echo $$ident | tr _ -` ; \
256
+
r="$$r s/([^\w\-])$$ident([^\w\-])/\1\&$$entity\;\2/g;";\
257
+
done; \
250
258
expand --tabs=8 < $< | \
251
259
sed $(ESCAPE) $(DVB_DOCUMENTED) | \
252
-
sed 's/i\.e\./&ie;/') >> $@
260
+
sed 's/i\.e\./&ie;/' | \
261
+
perl -ne "$$r print $$_;") >> $@
253
262
@( \
254
263
echo "</programlisting>") >> $@
255
264
+37
-20
Documentation/DocBook/media/dvb/demux.xml
+37
-20
Documentation/DocBook/media/dvb/demux.xml
···
8
8
<title>Demux Data Types</title>
9
9
10
10
<section id="dmx-output-t">
11
-
<title>dmx_output_t</title>
12
-
<programlisting>
13
-
typedef enum
14
-
{
15
-
DMX_OUT_DECODER, /⋆ Streaming directly to decoder. ⋆/
16
-
DMX_OUT_TAP, /⋆ Output going to a memory buffer ⋆/
17
-
/⋆ (to be retrieved via the read command).⋆/
18
-
DMX_OUT_TS_TAP, /⋆ Output multiplexed into a new TS ⋆/
19
-
/⋆ (to be retrieved by reading from the ⋆/
20
-
/⋆ logical DVR device). ⋆/
21
-
DMX_OUT_TSDEMUX_TAP /⋆ Like TS_TAP but retrieved from the DMX device ⋆/
22
-
} dmx_output_t;
23
-
</programlisting>
24
-
<para><constant>DMX_OUT_TAP</constant> delivers the stream output to the demux device on which the ioctl is
25
-
called.
26
-
</para>
27
-
<para><constant>DMX_OUT_TS_TAP</constant> routes output to the logical DVR device <constant>/dev/dvb/adapter?/dvr?</constant>,
28
-
which delivers a TS multiplexed from all filters for which <constant>DMX_OUT_TS_TAP</constant> was
29
-
specified.
30
-
</para>
11
+
<title>Output for the demux</title>
12
+
13
+
<table pgwide="1" frame="none" id="dmx-output">
14
+
<title>enum dmx_output</title>
15
+
<tgroup cols="2">
16
+
&cs-def;
17
+
<thead>
18
+
<row>
19
+
<entry>ID</entry>
20
+
<entry>Description</entry>
21
+
</row>
22
+
</thead>
23
+
<tbody valign="top">
24
+
<row>
25
+
<entry align="char" id="DMX-OUT-DECODER">DMX_OUT_DECODER</entry>
26
+
<entry>Streaming directly to decoder.</entry>
27
+
</row><row>
28
+
<entry align="char" id="DMX-OUT-TAP">DMX_OUT_TAP</entry>
29
+
<entry>Output going to a memory buffer (to be retrieved via the
30
+
read command). Delivers the stream output to the demux
31
+
device on which the ioctl is called.</entry>
32
+
</row><row>
33
+
<entry align="char" id="DMX-OUT-TS-TAP">DMX_OUT_TS_TAP</entry>
34
+
<entry>Output multiplexed into a new TS (to be retrieved by
35
+
reading from the logical DVR device). Routes output to the
36
+
logical DVR device <constant>/dev/dvb/adapter?/dvr?</constant>,
37
+
which delivers a TS multiplexed from all filters for which
38
+
<constant>DMX_OUT_TS_TAP</constant> was specified.</entry>
39
+
</row><row>
40
+
<entry align="char" id="DMX-OUT-TSDEMUX-TAP">DMX_OUT_TSDEMUX_TAP</entry>
41
+
<entry>Like &DMX-OUT-TS-TAP; but retrieved from the DMX
42
+
device.</entry>
43
+
</row>
44
+
</tbody>
45
+
</tgroup>
46
+
</table>
47
+
31
48
</section>
32
49
33
50
<section id="dmx-input-t">
+3
-3
include/uapi/linux/dvb/dmx.h
+3
-3
include/uapi/linux/dvb/dmx.h
···
32
32
33
33
#define DMX_FILTER_SIZE 16
34
34
35
-
typedef enum dmx_output
35
+
enum dmx_output
36
36
{
37
37
DMX_OUT_DECODER, /* Streaming directly to decoder. */
38
38
DMX_OUT_TAP, /* Output going to a memory buffer */
···
41
41
/* (to be retrieved by reading from the */
42
42
/* logical DVR device). */
43
43
DMX_OUT_TSDEMUX_TAP /* Like TS_TAP but retrieved from the DMX device */
44
-
} dmx_output_t;
44
+
};
45
45
46
+
typedef enum dmx_output dmx_output_t;
46
47
47
48
typedef enum dmx_input
48
49
{
···
139
138
unsigned int base; /* output: divisor for stc to get 90 kHz clock */
140
139
__u64 stc; /* output: stc in 'base'*90 kHz units */
141
140
};
142
-
143
141
144
142
#define DMX_START _IO('o', 41)
145
143
#define DMX_STOP _IO('o', 42)