From 5bd4bb7817093e9e3fe2671832de3486cb58b28b Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Wed, 17 Aug 2016 08:14:19 -0300 Subject: [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 --- Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst | 4 ++++ Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst | 10 ++++++++++ Documentation/media/uapi/cec/cec-ioc-dqevent.rst | 10 ++++++++++ Documentation/media/uapi/cec/cec-ioc-g-mode.rst | 6 ++++++ Documentation/media/uapi/cec/cec-ioc-receive.rst | 6 ++++++ 5 files changed, 36 insertions(+) (limited to 'Documentation/media/uapi/cec') diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst index 2516d4c..4e70eae 100644 --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst +++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst @@ -44,6 +44,8 @@ returns the information to the application. The ioctl never fails. .. _cec-caps: +.. tabularcolumns:: |p{1.0cm}|p{1.0cm}|p{15.5cm}| + .. flat-table:: struct cec_caps :header-rows: 0 :stub-columns: 0 @@ -89,6 +91,8 @@ returns the information to the application. The ioctl never fails. .. _cec-capabilities: +.. tabularcolumns:: |p{4.4cm}|p{1.5cm}|p{11.6cm}| + .. flat-table:: CEC Capabilities Flags :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst index 359f7b3..11fac7e 100644 --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst +++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst @@ -69,6 +69,8 @@ logical address types are already defined will return with error ``EBUSY``. .. _cec-log-addrs: +.. tabularcolumns:: |p{1.0cm}|p{1.0cm}|p{15.5cm}| + .. flat-table:: struct cec_log_addrs :header-rows: 0 :stub-columns: 0 @@ -205,6 +207,8 @@ logical address types are already defined will return with error ``EBUSY``. .. _cec-versions: +.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| + .. flat-table:: CEC Versions :header-rows: 0 :stub-columns: 0 @@ -239,6 +243,8 @@ logical address types are already defined will return with error ``EBUSY``. .. _cec-prim-dev-types: +.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| + .. flat-table:: CEC Primary Device Types :header-rows: 0 :stub-columns: 0 @@ -305,6 +311,8 @@ logical address types are already defined will return with error ``EBUSY``. .. _cec-log-addr-types: +.. tabularcolumns:: |p{2.6cm}|p{0.9cm}|p{14.0cm}| + .. flat-table:: CEC Logical Address Types :header-rows: 0 :stub-columns: 0 @@ -373,6 +381,8 @@ logical address types are already defined will return with error ``EBUSY``. .. _cec-all-dev-types-flags: +.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| + .. flat-table:: CEC All Device Types Flags :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst index 36eb4f9..b4c73ed 100644 --- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst +++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst @@ -54,6 +54,8 @@ it is guaranteed that the state did change in between the two events. .. _cec-event-state-change_s: +.. tabularcolumns:: |p{1.8cm}|p{1.8cm}|p{13.9cm}| + .. flat-table:: struct cec_event_state_change :header-rows: 0 :stub-columns: 0 @@ -80,6 +82,8 @@ it is guaranteed that the state did change in between the two events. .. _cec-event-lost-msgs_s: +.. tabularcolumns:: |p{1.0cm}|p{1.0cm}|p{15.5cm}| + .. flat-table:: struct cec_event_lost_msgs :header-rows: 0 :stub-columns: 0 @@ -106,6 +110,8 @@ it is guaranteed that the state did change in between the two events. .. _cec-event: +.. tabularcolumns:: |p{1.6cm}|p{1.6cm}|p{1.6cm}|p{12.7cm}| + .. flat-table:: struct cec_event :header-rows: 0 :stub-columns: 0 @@ -177,6 +183,8 @@ it is guaranteed that the state did change in between the two events. .. _cec-events: +.. tabularcolumns:: |p{2.6cm}|p{0.9cm}|p{14.0cm}| + .. flat-table:: CEC Events Types :header-rows: 0 :stub-columns: 0 @@ -206,6 +214,8 @@ it is guaranteed that the state did change in between the two events. .. _cec-event-flags: +.. tabularcolumns:: |p{4.4cm}|p{1.5cm}|p{11.6cm}| + .. flat-table:: CEC Event Flags :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/cec/cec-ioc-g-mode.rst b/Documentation/media/uapi/cec/cec-ioc-g-mode.rst index c0e851f..d213432 100644 --- a/Documentation/media/uapi/cec/cec-ioc-g-mode.rst +++ b/Documentation/media/uapi/cec/cec-ioc-g-mode.rst @@ -76,6 +76,8 @@ Available initiator modes are: .. _cec-mode-initiator_e: +.. tabularcolumns:: |p{2.6cm}|p{0.9cm}|p{14.0cm}| + .. flat-table:: Initiator Modes :header-rows: 0 :stub-columns: 0 @@ -119,6 +121,8 @@ Available follower modes are: .. _cec-mode-follower_e: +.. tabularcolumns:: |p{2.6cm}|p{0.9cm}|p{14.0cm}| + .. flat-table:: Follower Modes :header-rows: 0 :stub-columns: 0 @@ -211,6 +215,8 @@ Core message processing details: .. _cec-core-processing: +.. tabularcolumns:: |p{1.9cm}|p{15.6cm}| + .. flat-table:: Core Message Processing :header-rows: 0 :stub-columns: 0 diff --git a/Documentation/media/uapi/cec/cec-ioc-receive.rst b/Documentation/media/uapi/cec/cec-ioc-receive.rst index 7167a90..1a06c8d 100644 --- a/Documentation/media/uapi/cec/cec-ioc-receive.rst +++ b/Documentation/media/uapi/cec/cec-ioc-receive.rst @@ -75,6 +75,8 @@ result. .. _cec-msg: +.. tabularcolumns:: |p{1.0cm}|p{1.0cm}|p{15.5cm}| + .. flat-table:: struct cec_msg :header-rows: 0 :stub-columns: 0 @@ -252,6 +254,8 @@ result. .. _cec-tx-status: +.. tabularcolumns:: |p{2.6cm}|p{0.9cm}|p{14.0cm}| + .. flat-table:: CEC Transmit Status :header-rows: 0 :stub-columns: 0 @@ -320,6 +324,8 @@ result. .. _cec-rx-status: +.. tabularcolumns:: |p{2.6cm}|p{0.9cm}|p{14.0cm}| + .. flat-table:: CEC Receive Status :header-rows: 0 :stub-columns: 0 -- cgit v1.1