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

doc-rst: linux_tv: Fix some occurences of :sub: 



The right way to use it seems to do suscript is to use
this pattern: "\ :sub:"

Make sure all places of the media document will fit, by
using this script:

$n=0;
while (<>) {
	$n++;
	$t = $_;
	@matches = $t =~ m/(..\:sub\:)/g;
	foreach my $m (@matches) {
		$m =~ m/(.)(.)(\:sub\:)/;
		$s1=$1;
		$s2=$2;
		$s3=$3;
		next if (($s1 eq "\\") && ($s2 eq " "));
		if ($s2 eq " ") {
			$t =~ s/$s1$s2$s3/$s1\\$s2$s3/;
			next;
		}
		$t =~ s/$s1$s2$s3/$s1$s2\\ $s3/;
	}
	print $t;
}

And running it with:

for i in $(git grep -l sub Documentation/linux_tv/); do ./sub.pl $i >a && mv a $i; done

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

Documentation/linux_tv/media/v4l/dev-sliced-vbi.rst

+1 −1
Original line number Diff line number Diff line
@@ -676,7 +676,7 @@ number). 
          sliced VBI data. The sliced VBI data lines present correspond to

          the bits set in the ``linemask`` array, starting from b\ :sub:`0`

          of ``linemask``\ [0] up through b\ :sub:`31` of ``linemask``\ [0],

          and from b\ :sub:`0` of ``linemask``\ [1] up through b :sub:`3` of

          and from b\ :sub:`0` of ``linemask``\ [1] up through b\ :sub:`3` of

          ``linemask``\ [1]. ``line``\ [0] corresponds to the first bit

          found set in the ``linemask`` array, ``line``\ [1] corresponds to

          the second bit found set in the ``linemask`` array, etc. If no

Documentation/linux_tv/media/v4l/pixfmt-m420.rst

+1 −1
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ Two lines of luma data are followed by one line of chroma data. 
The luma plane has one byte per pixel. The chroma plane contains

interleaved CbCr pixels subsampled by ½ in the horizontal and vertical

directions. Each CbCr pair belongs to four pixels. For example,

Cb\ :sub:`0`/Cr:sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`,

Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`,

Y'\ :sub:`10`, Y'\ :sub:`11`.



All line lengths are identical: if the Y lines include pad bytes so do

Documentation/linux_tv/media/v4l/pixfmt-nv12.rst

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_NV12``, a 
combined CbCr plane immediately follows the Y plane in memory. The CbCr

plane is the same width, in bytes, as the Y plane (and of the image),

but is half as tall in pixels. Each CbCr pair belongs to four pixels.

For example, Cb\ :sub:`0`/Cr:sub:`0` belongs to Y'\ :sub:`00`,

For example, Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`,

Y'\ :sub:`01`, Y'\ :sub:`10`, Y'\ :sub:`11`. ``V4L2_PIX_FMT_NV21`` is

the same except the Cb and Cr bytes are swapped, the CrCb plane starts

with a Cr byte.

Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst

+2 −2
Original line number Diff line number Diff line
@@ -26,8 +26,8 @@ occupies the first plane. The Y plane has one byte per pixel. In the 
second plane there is a chrominance data with alternating chroma

samples. The CbCr plane is the same width, in bytes, as the Y plane (and

of the image), but is half as tall in pixels. Each CbCr pair belongs to

four pixels. For example, Cb :sub:`0`/Cr :sub:`0` belongs to

Y' :sub:`00`, Y' :sub:`01`, Y' :sub:`10`, Y' :sub:`11`.

four pixels. For example, Cb\ :sub:`0`/Cr\ :sub:`0` belongs to

Y'\ :sub:`00`, Y'\ :sub:`01`, Y'\ :sub:`10`, Y'\ :sub:`11`.

``V4L2_PIX_FMT_NV12MT_16X16`` is the tiled version of

``V4L2_PIX_FMT_NV12M`` with 16x16 macroblock tiles. Here pixels are

arranged in 16x16 2D tiles and tiles are arranged in linear order in

Documentation/linux_tv/media/v4l/pixfmt-nv16.rst

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_NV16``, a 
combined CbCr plane immediately follows the Y plane in memory. The CbCr

plane is the same width and height, in bytes, as the Y plane (and of the

image). Each CbCr pair belongs to two pixels. For example,

Cb\ :sub:`0`/Cr:sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`.

Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`.

``V4L2_PIX_FMT_NV61`` is the same except the Cb and Cr bytes are

swapped, the CrCb plane starts with a Cr byte.