Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit cf8076c3 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] docs-rst: Convert DVB uAPI to use C function references 



Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

While here, improve the documentation, marking the deprecated
ioctls, and making the non-deprecated ones more like the rest
of the media book.

Also, add a notice for ioctls that still require documentation.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 41d80465

Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst

+5 −10
Original line number Diff line number Diff line
@@ -11,11 +11,13 @@ Name 


AUDIO_BILINGUAL_CHANNEL_SELECT



.. attention:: This ioctl is deprecated



Synopsis

--------



.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)

.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)

    :name: AUDIO_BILINGUAL_CHANNEL_SELECT





Arguments
@@ -25,20 +27,13 @@ Arguments 
    :header-rows:  0

    :stub-columns: 0





    -  .. row 1

    -



       -  int fd



       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_BILINGUAL_CHANNEL_SELECT for this command.



    -  .. row 3

    -



       -  audio_channel_select_t ch

Documentation/media/uapi/dvb/audio-channel-select.rst

+5 −9
Original line number Diff line number Diff line
@@ -11,11 +11,13 @@ Name 


AUDIO_CHANNEL_SELECT



.. attention:: This ioctl is deprecated



Synopsis

--------



.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)

.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, audio_channel_select_t)

    :name: AUDIO_CHANNEL_SELECT





Arguments
@@ -26,19 +28,13 @@ Arguments 
    :stub-columns: 0





    -  .. row 1

    -



       -  int fd



       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_CHANNEL_SELECT for this command.



    -  .. row 3

    -



       -  audio_channel_select_t ch

Documentation/media/uapi/dvb/audio-clear-buffer.rst

+3 −9
Original line number Diff line number Diff line
@@ -11,12 +11,13 @@ Name 


AUDIO_CLEAR_BUFFER



.. attention:: This ioctl is deprecated



Synopsis

--------



.. c:function:: int  ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)



.. c:function:: int  ioctl(int fd, AUDIO_CLEAR_BUFFER)

    :name: AUDIO_CLEAR_BUFFER



Arguments

---------
@@ -32,13 +33,6 @@ Arguments 


       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_CLEAR_BUFFER for this command.





Description

-----------

Documentation/media/uapi/dvb/audio-continue.rst

+3 −8
Original line number Diff line number Diff line
@@ -11,11 +11,13 @@ Name 


AUDIO_CONTINUE



.. attention:: This ioctl is deprecated



Synopsis

--------



.. c:function:: int  ioctl(int fd, int request = AUDIO_CONTINUE)

.. c:function:: int  ioctl(int fd, AUDIO_CONTINUE)

    :name: AUDIO_CONTINUE





Arguments
@@ -32,13 +34,6 @@ Arguments 


       -  File descriptor returned by a previous call to open().



    -  .. row 2



       -  int request



       -  Equals AUDIO_CONTINUE for this command.





Description

-----------

Documentation/media/uapi/dvb/audio-fclose.rst

+3 −1
Original line number Diff line number Diff line
@@ -11,11 +11,13 @@ Name 


DVB audio close()



.. attention:: This ioctl is deprecated



Synopsis

--------



.. c:function:: int close(int fd)

    :name: dvb-audio-close





Arguments