[media] DocBook: Add xref links for DTV propeties

Create xref links for all DTV properties and link the frontend.h
to each. Also use them at the DVB frontent API example.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-05-26 11:35:44 -03:00
parent e4aa18d33c
commit c569eb707a
2 changed files with 20 additions and 6 deletions

View File

@ -73,6 +73,9 @@ IOCTLS = \
VIDIOC_SUBDEV_G_SELECTION \
VIDIOC_SUBDEV_S_SELECTION \
DEFINES = \
$(shell perl -ne 'print "$$1 " if /\#define\s+(DTV_[^\s]+)\s+/' $(srctree)/include/uapi/linux/dvb/frontend.h) \
TYPES = \
$(shell perl -ne 'print "$$1 " if /^typedef\s+[^\s]+\s+([^\s]+)\;/' $(srctree)/include/uapi/linux/videodev2.h) \
$(shell perl -ne 'print "$$1 " if /^}\s+([a-z0-9_]+_t)/' $(srctree)/include/uapi/linux/dvb/frontend.h)
@ -187,8 +190,10 @@ DVB_DOCUMENTED = \
-e "s,\(audio-mixer\|audio-karaoke\|audio-status\|ca-slot-info\|ca-descr-info\|ca-caps\|ca-msg\|ca-descr\|ca-pid\|dmx-filter\|dmx-caps\|video-system\|video-highlight\|video-spu\|video-spu-palette\|video-navi-pack\)-t,\1,g" \
-e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
-e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
-e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
-e "s,<link\s\+linkend=\".*\">\(__.*_OLD\)<\/link>,\1,g" \
-e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \
-e "s,<link\s\+linkend=\".*\">\(DTV_ISDBS_TS_ID_LEGACY\|DTV_MAX_COMMAND\|DTV_IOCTL_MAX_MSGS\)<\/link>,\1,g" \
#
# Media targets and dependencies
@ -306,6 +311,15 @@ $(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
>>$@ ; \
done)
@( \
echo -e "\n<!-- Defines -->") >>$@
@( \
for ident in $(DEFINES) ; do \
entity=`echo $$ident | tr _ -` ; \
echo "<!ENTITY $$entity \"<link" \
"linkend='$$entity'><constant>$$ident</constant></link>\">" \
>>$@ ; \
done)
@( \
echo -e "\n<!-- Types -->") >>$@
@( \
for ident in $(TYPES) ; do \

View File

@ -20,12 +20,12 @@
rate of 5.217 Mbauds, those properties should be sent to
<link linkend="FE_GET_PROPERTY"><constant>FE_SET_PROPERTY</constant></link> ioctl:</para>
<itemizedlist>
<listitem>DTV_FREQUENCY = 651000000</listitem>
<listitem>DTV_MODULATION = QAM_256</listitem>
<listitem>DTV_INVERSION = INVERSION_AUTO</listitem>
<listitem>DTV_SYMBOL_RATE = 5217000</listitem>
<listitem>DTV_INNER_FEC = FEC_3_4</listitem>
<listitem>DTV_TUNE</listitem>
<listitem>&DTV-FREQUENCY; = 651000000</listitem>
<listitem>&DTV-MODULATION; = QAM_256</listitem>
<listitem>&DTV-INVERSION; = INVERSION_AUTO</listitem>
<listitem>&DTV-SYMBOL-RATE; = 5217000</listitem>
<listitem>&DTV-INNER-FEC; = FEC_3_4</listitem>
<listitem>&DTV-TUNE;</listitem>
</itemizedlist>
<para>NOTE: This section describes the DVB version 5 extension of the DVB-API,
also called "S2API", as this API were added to provide support for DVB-S2. It