AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2025-01-13 12:36:21 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity
4eb40f14dc
linux_dsm_epyc7002/Documentation/linux_tv/media/dvb/audio-play.rst

54 lines
795 B
ReStructuredText
Raw Normal View History

doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
.. -*- coding: utf-8; mode: rst -*-
.. _AUDIO_PLAY:
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 17:58:48 +07:00
==========
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
AUDIO_PLAY
==========
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 17:58:48 +07:00
NAME
----
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 17:58:48 +07:00
AUDIO_PLAY
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 17:58:48 +07:00
SYNOPSIS
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 17:58:48 +07:00
ARGUMENTS
---------
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
.. flat-table::
: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_PLAY for this command.
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 17:58:48 +07:00
DESCRIPTION
-----------
This ioctl call asks the Audio Device to start playing an audio stream
from the selected source.
RETURN VALUE
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 20:37:31 +07:00
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
Reference in New Issue Copy Permalink