[media] docs-rst: escape [] characters

Those characters are used for citations. Better to escape, to
avoid them to be misinterpreted.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab
2016-07-12 15:20:11 -03:00
parent 4855307b81
commit ffbab694ed
68 changed files with 188 additions and 188 deletions
@@ -52,7 +52,7 @@ returns the information to the application. The ioctl never fails.
- char
- ``driver[32]``
- ``driver\[32\]``
- The name of the cec adapter driver.
@@ -60,7 +60,7 @@ returns the information to the application. The ioctl never fails.
- char
- ``name[32]``
- ``name\[32\]``
- The name of this CEC adapter. The combination ``driver`` and
``name`` must be unique.
@@ -70,7 +70,7 @@ by a file handle in initiator mode (see
- The actual logical addresses that were claimed. This is set by the
driver. If no logical address could be claimed, then it is set to
``CEC_LOG_ADDR_INVALID``. If this adapter is Unregistered, then
``log_addr[0]`` is set to 0xf and all others to
``log_addr\[0\]`` is set to 0xf and all others to
``CEC_LOG_ADDR_INVALID``.
- .. row 2
@@ -138,7 +138,7 @@ by a file handle in initiator mode (see
- char
- ``osd_name``\ [15]
- ``osd_name``\ \[15\]
- The On-Screen Display name as is returned by the
``CEC_MSG_SET_OSD_NAME`` message.
@@ -178,7 +178,7 @@ by a file handle in initiator mode (see
- __u8
- ``features`` [CEC_MAX_LOG_ADDRS][12]
- ``features`` [CEC_MAX_LOG_ADDRS]\[12\]
- Features for each logical address. Used to implement the
``CEC_MSG_REPORT_FEATURES`` message. The 12 bytes include both the
@@ -139,7 +139,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- __u8
- ``msg``\ [16]
- ``msg``\ \[16\]
- The message payload. For :ref:`CEC_TRANSMIT` this is filled in by the
application. The driver will fill this in for :ref:`CEC_RECEIVE` and
@@ -77,7 +77,7 @@ ca_msg_t
unsigned int index;
unsigned int type;
unsigned int length;
unsigned char msg[256];
unsigned char msg\[256\];
} ca_msg_t;
@@ -92,7 +92,7 @@ ca_descr_t
typedef struct ca_descr {
unsigned int index;
unsigned int parity;
unsigned char cw[8];
unsigned char cw\[8\];
} ca_descr_t;
@@ -15,7 +15,7 @@ DMX_GET_PES_PIDS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
.. cpp:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16\[5\])
Arguments
@@ -40,7 +40,7 @@ Arguments
- .. row 3
- __u16[5]
- __u16\[5\]
- Undocumented.
@@ -13,14 +13,14 @@ struct dtv_property
struct dtv_property {
__u32 cmd;
__u32 reserved[3];
__u32 reserved\[3\];
union {
__u32 data;
struct dtv_fe_stats st;
struct {
__u8 data[32];
__u8 data\[32\];
__u32 len;
__u32 reserved1[3];
__u32 reserved1\[3\];
void *reserved2;
} buffer;
} u;
+9 -9
View File
@@ -87,7 +87,7 @@ tuners, but can easily be adjusted for QAM.
struct secCmdSequence scmds;
struct dmx_pes_filter_params pesFilterParams;
FrontendParameters frp;
struct pollfd pfd[1];
struct pollfd pfd\[1\];
FrontendEvent event;
int demux1, demux2, demux3, front;
@@ -143,7 +143,7 @@ tuners, but can easily be adjusted for QAM.
scmd.u.diseqc.addr=0x10;
scmd.u.diseqc.cmd=0x38;
scmd.u.diseqc.numParams=1;
scmd.u.diseqc.params[0] = 0xF0 | ((diseqc * 4) & 0x0F) |
scmd.u.diseqc.params\[0\] = 0xF0 | ((diseqc * 4) & 0x0F) |
(scmds.continuousTone == SEC_TONE_ON ? 1 : 0) |
(scmds.voltage==SEC_VOLTAGE_18 ? 2 : 0);
@@ -168,11 +168,11 @@ tuners, but can easily be adjusted for QAM.
return -1;
}
pfd[0].fd = front;
pfd[0].events = POLLIN;
pfd\[0\].fd = front;
pfd\[0\].events = POLLIN;
if (poll(pfd,1,3000)){
if (pfd[0].revents & POLLIN){
if (pfd\[0\].revents & POLLIN){
printf("Getting QPSK event\\n");
if ( ioctl(front, FE_GET_EVENT, &event)
@@ -324,7 +324,7 @@ recording.
int written;
uint8_t buf[BUFFY];
uint64_t length;
struct pollfd pfd[1];
struct pollfd pfd\[1\];
int dvr, dvr_out;
/* open dvr device */
@@ -351,13 +351,13 @@ recording.
return -1;
}
pfd[0].fd = dvr;
pfd[0].events = POLLIN;
pfd\[0\].fd = dvr;
pfd\[0\].events = POLLIN;
/* poll for dvr data and write to file */
while (length < MAX_LENGTH ) {
if (poll(pfd,1,1)){
if (pfd[0].revents & POLLIN){
if (pfd\[0\].revents & POLLIN){
len = read(dvr, buf, BUFFY);
if (len < 0){
perror("recording");
@@ -52,9 +52,9 @@ struct dvb_diseqc_slave_reply
- uint8_t
- msg[4]
- msg\[4\]
- DiSEqC message (framing, data[3])
- DiSEqC message (framing, data\[3\])
- .. row 2
@@ -52,9 +52,9 @@ struct dvb_diseqc_master_cmd
- uint8_t
- msg[6]
- msg\[6\]
- DiSEqC message (framing, address, command, data[3])
- DiSEqC message (framing, address, command, data\[3\])
- .. row 2
+1 -1
View File
@@ -57,7 +57,7 @@ struct dvb_frontend_info
- char
- name[128]
- name\[128\]
- Name of the frontend
+2 -2
View File
@@ -125,7 +125,7 @@ it can be extended safely in the future.
} play;
struct {
__u32 data[16];
__u32 data\[16\];
} raw;
};
};
@@ -352,7 +352,7 @@ passed to the ioctl VIDEO_GET_NAVI:
typedef
struct video_navi_pack {
int length; /* 0 ... 1024 */
uint8_t data[1024];
uint8_t data\[1024\];
} video_navi_pack_t;
@@ -52,7 +52,7 @@ ioctl never fails.
- char
- ``driver``\ [16]
- ``driver``\ \[16\]
- Name of the driver implementing the media API as a NUL-terminated
ASCII string. The driver version is stored in the
@@ -66,7 +66,7 @@ ioctl never fails.
- char
- ``model``\ [32]
- ``model``\ \[32\]
- Device model name as a NUL-terminated UTF-8 string. The device
version is stored in the ``device_version`` field and is not be
@@ -76,7 +76,7 @@ ioctl never fails.
- char
- ``serial``\ [40]
- ``serial``\ \[40\]
- Serial number as a NUL-terminated ASCII string.
@@ -84,7 +84,7 @@ ioctl never fails.
- char
- ``bus_info``\ [32]
- ``bus_info``\ \[32\]
- Location of the device in the system as a NUL-terminated ASCII
string. This includes the bus type name (PCI, USB, ...) and a
@@ -120,7 +120,7 @@ ioctl never fails.
- __u32
- ``reserved``\ [31]
- ``reserved``\ \[31\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -75,7 +75,7 @@ id's until they get an error.
- char
- ``name``\ [32]
- ``name``\ \[32\]
-
-
@@ -181,7 +181,7 @@ id's until they get an error.
-
- __u8
- ``raw``\ [184]
- ``raw``\ \[184\]
-
-
@@ -163,7 +163,7 @@ desired arrays with the media graph elements.
- char
- ``name``\ [64]
- ``name``\ \[64\]
- Entity name as an UTF-8 NULL-terminated string.
@@ -179,7 +179,7 @@ desired arrays with the media graph elements.
- __u32
- ``reserved``\ [12]
- ``reserved``\ \[12\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -221,7 +221,7 @@ desired arrays with the media graph elements.
- __u32
- ``reserved``\ [9]
- ``reserved``\ \[9\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -299,7 +299,7 @@ desired arrays with the media graph elements.
- __u32
- ``reserved``\ [9]
- ``reserved``\ \[9\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -354,7 +354,7 @@ desired arrays with the media graph elements.
- __u32
- ``reserved``\ [5]
- ``reserved``\ \[5\]
- Reserved for future extensions. Drivers and applications must set
this array to zero.
+21 -21
View File
@@ -35,16 +35,16 @@ file: uapi/v4l/keytable.c
struct parse_key *p;
for (p=keynames;p->name!=NULL;p++) {
if (p->value == (unsigned)codes[1]) {
printf("scancode 0x%04x = %s (0x%02x)\\n", codes[0], p->name, codes[1]);
if (p->value == (unsigned)codes\[1\]) {
printf("scancode 0x%04x = %s (0x%02x)\\n", codes\[0\], p->name, codes\[1\]);
return;
}
}
if (isprint (codes[1]))
printf("scancode %d = '%c' (0x%02x)\\n", codes[0], codes[1], codes[1]);
if (isprint (codes\[1\]))
printf("scancode %d = '%c' (0x%02x)\\n", codes\[0\], codes\[1\], codes\[1\]);
else
printf("scancode %d = 0x%02x\\n", codes[0], codes[1]);
printf("scancode %d = 0x%02x\\n", codes\[0\], codes\[1\]);
}
int parse_code(char *string)
@@ -63,7 +63,7 @@ file: uapi/v4l/keytable.c
{
int fd;
unsigned int i, j;
int codes[2];
int codes\[2\];
if (argc<2 || argc>4) {
printf ("usage: %s <device> to get table; or\\n"
@@ -72,7 +72,7 @@ file: uapi/v4l/keytable.c
return -1;
}
if ((fd = open(argv[1], O_RDONLY)) < 0) {
if ((fd = open(argv\[1\], O_RDONLY)) < 0) {
perror("Couldn't open input device");
return(-1);
}
@@ -80,16 +80,16 @@ file: uapi/v4l/keytable.c
if (argc==4) {
int value;
value=parse_code(argv[3]);
value=parse_code(argv\[3\]);
if (value==-1) {
value = strtol(argv[3], NULL, 0);
value = strtol(argv\[3\], NULL, 0);
if (errno)
perror("value");
}
codes [0] = (unsigned) strtol(argv[2], NULL, 0);
codes [1] = (unsigned) value;
codes \[0\] = (unsigned) strtol(argv\[2\], NULL, 0);
codes \[1\] = (unsigned) value;
if(ioctl(fd, EVIOCSKEYCODE, codes))
perror ("EVIOCSKEYCODE");
@@ -102,9 +102,9 @@ file: uapi/v4l/keytable.c
if (argc==3) {
FILE *fin;
int value;
char *scancode, *keycode, s[2048];
char *scancode, *keycode, s\[2048\];
fin=fopen(argv[2],"r");
fin=fopen(argv\[2\],"r");
if (fin==NULL) {
perror ("opening keycode file");
return -1;
@@ -113,8 +113,8 @@ file: uapi/v4l/keytable.c
/* Clears old table */
for (j = 0; j < 256; j++) {
for (i = 0; i < 256; i++) {
codes[0] = (j << 8) | i;
codes[1] = KEY_RESERVED;
codes\[0\] = (j << 8) | i;
codes\[1\] = KEY_RESERVED;
ioctl(fd, EVIOCSKEYCODE, codes);
}
}
@@ -149,12 +149,12 @@ file: uapi/v4l/keytable.c
perror("value");
}
codes [0] = (unsigned) strtol(scancode, NULL, 0);
codes [1] = (unsigned) value;
codes \[0\] = (unsigned) strtol(scancode, NULL, 0);
codes \[1\] = (unsigned) value;
// printf("\\t%04x=%04x\\n",codes[0], codes[1]);
// printf("\\t%04x=%04x\\n",codes\[0\], codes\[1\]);
if(ioctl(fd, EVIOCSKEYCODE, codes)) {
fprintf(stderr, "Setting scancode 0x%04x with 0x%04x via ",codes[0], codes[1]);
fprintf(stderr, "Setting scancode 0x%04x with 0x%04x via ",codes\[0\], codes\[1\]);
perror ("EVIOCSKEYCODE");
}
@@ -167,8 +167,8 @@ file: uapi/v4l/keytable.c
/* Get scancode table */
for (j = 0; j < 256; j++) {
for (i = 0; i < 256; i++) {
codes[0] = (j << 8) | i;
if (!ioctl(fd, EVIOCGKEYCODE, codes) && codes[1] != KEY_RESERVED)
codes\[0\] = (j << 8) | i;
if (!ioctl(fd, EVIOCGKEYCODE, codes) && codes\[1\] != KEY_RESERVED)
prtcode(codes);
}
}
+2 -2
View File
@@ -379,7 +379,7 @@ struct v4l2_plane
- __u32
- ``reserved[11]``
- ``reserved\[11\]``
-
- Reserved for future use. Should be zeroed by drivers and
@@ -868,7 +868,7 @@ struct v4l2_timecode
- __u8
- ``userbits``\ [4]
- ``userbits``\ \[4\]
- The "user group" bits from the timecode.
+7 -7
View File
@@ -88,7 +88,7 @@ file: media/v4l/capture.c
switch (io) {
case IO_METHOD_READ:
if (-1 == read(fd, buffers[0].start, buffers[0].length)) {
if (-1 == read(fd, buffers\[0\].start, buffers\[0\].length)) {
switch (errno) {
case EAGAIN:
return 0;
@@ -103,7 +103,7 @@ file: media/v4l/capture.c
}
}
process_image(buffers[0].start, buffers[0].length);
process_image(buffers\[0\].start, buffers\[0\].length);
break;
case IO_METHOD_MMAP:
@@ -284,7 +284,7 @@ file: media/v4l/capture.c
switch (io) {
case IO_METHOD_READ:
free(buffers[0].start);
free(buffers\[0\].start);
break;
case IO_METHOD_MMAP:
@@ -311,10 +311,10 @@ file: media/v4l/capture.c
exit(EXIT_FAILURE);
}
buffers[0].length = buffer_size;
buffers[0].start = malloc(buffer_size);
buffers\[0\].length = buffer_size;
buffers\[0\].start = malloc(buffer_size);
if (!buffers[0].start) {
if (!buffers\[0\].start) {
fprintf(stderr, "Out of memory\\n");
exit(EXIT_FAILURE);
}
@@ -575,7 +575,7 @@ file: media/v4l/capture.c
"-f | --format Force format to 640x480 YUYVn"
"-c | --count Number of frames to grab [%i]n"
"",
argv[0], dev_name, frame_count);
argv\[0\], dev_name, frame_count);
}
static const char short_options[] = "d:hmruofc:";
+1 -1
View File
@@ -68,7 +68,7 @@ Example: Finding a framebuffer device for OSD
}
for (i = 0; i < 30; i++) {
char dev_name[16];
char dev_name\[16\];
struct fb_fix_screeninfo si;
snprintf(dev_name, sizeof(dev_name), "/dev/fb%u", i);
+2 -2
View File
@@ -188,7 +188,7 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does
service transmissions embedded in the picture.
An application can set the first or second ``count`` value to zero
if no data is required from the respective field; ``count``\ [1]
if no data is required from the respective field; ``count``\ \[1\]
if the scanning system is progressive, i. e. not interlaced. The
corresponding start value shall be ignored by the application and
driver. Anyway, drivers may not support single field capturing and
@@ -318,7 +318,7 @@ The total size of a frame computes as follows:
.. code-block:: c
(count[0] + count[1]) * samples_per_line * sample size in bytes
(count\[0\] + count\[1\]) * samples_per_line * sample size in bytes
The sample size is most likely always one byte, applications must check
the ``sample_format`` field though, to function properly with other

Some files were not shown because too many files have changed in this diff Show More