redonkable/alistair23-linux
redonkable/alistair23-linux
1
0
Fork 0
Code Releases Activity

[media] DocBook: some fixes at FE_GET_INFO

Browse source 
There are a few issues at FE_GET_INFO documentation:
- name is a string, not a pointer to a string;
- the return text should be after the paragraph.

While here, better to bold that two fields of the structure used
by FE_GET_INFO are actually deprecated.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-05-28 14:32:28 -03:00
parent 997eb9039d
commit 704db8050d
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
Documentation/DocBook/media/dvb/fe-get-info.xml
View file

@ -53,8 +53,9 @@
kernel devices compatible with this specification and to obtain kernel devices compatible with this specification and to obtain
information about driver and hardware capabilities. The ioctl takes a information about driver and hardware capabilities. The ioctl takes a
pointer to dvb_frontend_info which is filled by the driver. When the pointer to dvb_frontend_info which is filled by the driver. When the
driver is not compatible with this specification the ioctl returns an error &return-value-dvb;. driver is not compatible with this specification the ioctl returns an error.
</para> </para>
&return-value-dvb;
<table pgwide="1" frame="none" id="dvb-frontend-info"> <table pgwide="1" frame="none" id="dvb-frontend-info">
<title>struct <structname>dvb_frontend_info</structname></title> <title>struct <structname>dvb_frontend_info</structname></title>
@ -62,13 +63,13 @@ driver is not compatible with this specification the ioctl returns an error &ret
&cs-str; &cs-str;
<tbody valign="top"> <tbody valign="top">
<row> <row>
<entry>char *</entry> <entry>char</entry>
<entry>name[128]</entry> <entry>name[128]</entry>
<entry>Name of the frontend</entry> <entry>Name of the frontend</entry>
</row><row> </row><row>
<entry>fe_type_t</entry> <entry>fe_type_t</entry>
<entry>type</entry> <entry>type</entry>
<entry>DVBv3 type. Should not be used on modern programs, as a <entry><emphasis role="bold">DEPRECATED</emphasis>. DVBv3 type. Should not be used on modern programs, as a
frontend may have more than one type. So, the DVBv5 API should frontend may have more than one type. So, the DVBv5 API should
be used instead to enumerate and select the frontend type.</entry> be used instead to enumerate and select the frontend type.</entry>
</row><row> </row><row>
@ -102,7 +103,7 @@ driver is not compatible with this specification the ioctl returns an error &ret
</row><row> </row><row>
<entry>uint32_t</entry> <entry>uint32_t</entry>
<entry>notifier_delay</entry> <entry>notifier_delay</entry>
<entry>Deprecated. Not used by any driver.</entry> <entry><emphasis role="bold">DEPRECATED</emphasis>. Not used by any driver.</entry>
</row><row> </row><row>
<entry>&fe-caps;</entry> <entry>&fe-caps;</entry>
<entry>caps</entry> <entry>caps</entry>