diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-17 13:14:19 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-22 15:07:12 +0200 |
| commit | 5bd4bb7817093e9e3fe2671832de3486cb58b28b (patch) | |
| tree | 47bfcad054bfeea42b866047032119c7c76d6a69 /Documentation/media/uapi/mediactl | |
| parent | [media] docs-rst: re-generate typical_media_device.pdf (diff) | |
| download | linux-5bd4bb7817093e9e3fe2671832de3486cb58b28b.tar.xz linux-5bd4bb7817093e9e3fe2671832de3486cb58b28b.zip | |
[media] docs-rst: add tabularcolumns to all tables
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.
As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:
my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
if (!$table_header) {
$has_cols = 1 if (m/..\s+tabularcolumns::/);
if (m/..\s+flat-table::/) {
$table_header = 1;
$header = $_;
next;
}
$out .= $_;
next;
}
$header .= $_;
@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
if (m/^\n$/) {
if (!$has_cols && @widths) {
my ($tot, $t, $i) = (0, 0, 0);
foreach my $v(@widths) { $tot += $v; };
$out .= ".. tabularcolumns:: |";
for ($i = 0; $i < scalar @widths - 1; $i++) {
my $v = $widths[$i];
my $w = round(10 * ($v * $line_size) / $tot) / 10;
$out .= sprintf "p{%.1fcm}|", $w;
$t += $w;
}
my $w = $line_size - $t;
$out .= sprintf "p{%.1fcm}|\n\n", $w;
}
$out .= $header;
$table_header = 0;
$has_cols = 0;
$header = "";
@widths = ();
}
}
print $out;
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/mediactl')
4 files changed, 22 insertions, 0 deletions
diff --git a/Documentation/media/uapi/mediactl/media-ioc-device-info.rst b/Documentation/media/uapi/mediactl/media-ioc-device-info.rst index 467d82cbb81e..567f5515a791 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-device-info.rst +++ b/Documentation/media/uapi/mediactl/media-ioc-device-info.rst @@ -42,6 +42,8 @@ ioctl never fails. .. _media-device-info: +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| + .. flat-table:: struct media_device_info :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst b/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst index 12d4b25d5b94..a51c4cc9f6d3 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst +++ b/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst @@ -53,6 +53,8 @@ id's until they get an error. .. _media-entity-desc: +.. tabularcolumns:: |p{1.5cm}|p{1.5cm}|p{1.5cm}|p{1.5cm}|p{11.5cm}| + .. flat-table:: struct media_entity_desc :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst b/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst index 87443b1ce42d..f4334f5765c6 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst +++ b/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst @@ -57,6 +57,8 @@ returned during the enumeration process. .. _media-links-enum: +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| + .. flat-table:: struct media_links_enum :header-rows: 0 :stub-columns: 0 @@ -93,6 +95,8 @@ returned during the enumeration process. .. _media-pad-desc: +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| + .. flat-table:: struct media_pad_desc :header-rows: 0 :stub-columns: 0 @@ -127,6 +131,8 @@ returned during the enumeration process. .. _media-link-desc: +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| + .. flat-table:: struct media_link_desc :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst b/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst index 2e382cc7762c..750dd11dbe03 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst +++ b/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst @@ -51,6 +51,8 @@ desired arrays with the media graph elements. .. _media-v2-topology: +.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| + .. flat-table:: struct media_v2_topology :header-rows: 0 :stub-columns: 0 @@ -145,6 +147,8 @@ desired arrays with the media graph elements. .. _media-v2-entity: +.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| + .. flat-table:: struct media_v2_entity :header-rows: 0 :stub-columns: 0 @@ -188,6 +192,8 @@ desired arrays with the media graph elements. .. _media-v2-interface: +.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| + .. flat-table:: struct media_v2_interface :header-rows: 0 :stub-columns: 0 @@ -239,6 +245,8 @@ desired arrays with the media graph elements. .. _media-v2-intf-devnode: +.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| + .. flat-table:: struct media_v2_interface :header-rows: 0 :stub-columns: 0 @@ -265,6 +273,8 @@ desired arrays with the media graph elements. .. _media-v2-pad: +.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| + .. flat-table:: struct media_v2_pad :header-rows: 0 :stub-columns: 0 @@ -308,6 +318,8 @@ desired arrays with the media graph elements. .. _media-v2-link: +.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| + .. flat-table:: struct media_v2_pad :header-rows: 0 :stub-columns: 0 |