Skip to content

Commit 6742b31

Browse files
committed
Add vertical borders to all tables
Add vertical markers to the table specs so that all the tables are nicely boxed in. Signed-off-by: Grant Likely <[email protected]>
1 parent 344826c commit 6742b31

File tree

3 files changed

+56
-55
lines changed

3 files changed

+56
-55
lines changed

source/device-bindings.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ here to facilitate standardization of names and usage.
6161
``clock-frequency`` Property
6262
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6363

64-
.. tabularcolumns:: l J
64+
.. tabularcolumns:: | l J |
6565
.. table:: ``clock-frequency`` Property
6666

6767
=========== ==============================================================
@@ -81,7 +81,7 @@ here to facilitate standardization of names and usage.
8181
``reg-shift`` Property
8282
^^^^^^^^^^^^^^^^^^^^^^
8383

84-
.. tabularcolumns:: l J
84+
.. tabularcolumns:: | l J |
8585
.. table:: ``reg-shift`` Property
8686

8787
=========== ==============================================================
@@ -105,7 +105,7 @@ here to facilitate standardization of names and usage.
105105
``label`` Property
106106
^^^^^^^^^^^^^^^^^^
107107

108-
.. tabularcolumns:: l J
108+
.. tabularcolumns:: | l J |
109109
.. table:: ``label`` Property
110110

111111
=========== ==============================================================
@@ -135,7 +135,7 @@ specific representation.
135135
``clock-frequency`` Property
136136
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
137137

138-
.. tabularcolumns:: l J
138+
.. tabularcolumns:: | l J |
139139
.. table:: ``clock-frequecy`` Property
140140

141141
=========== ==============================================================
@@ -223,7 +223,7 @@ Network Class Binding
223223
``address-bits`` Property
224224
^^^^^^^^^^^^^^^^^^^^^^^^^
225225

226-
.. tabularcolumns:: l J
226+
.. tabularcolumns:: | l J |
227227
.. table:: ``address-bits`` Property
228228

229229
=========== ==============================================================
@@ -239,7 +239,7 @@ Network Class Binding
239239
``local-mac-address`` Property
240240
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
241241

242-
.. tabularcolumns:: l J
242+
.. tabularcolumns:: | l J |
243243
.. table:: ``local-mac-address`` Property
244244

245245
=========== ==============================================================
@@ -254,7 +254,7 @@ Network Class Binding
254254
``mac-address`` Property
255255
^^^^^^^^^^^^^^^^^^^^^^^^
256256

257-
.. tabularcolumns:: l J
257+
.. tabularcolumns:: | l J |
258258
.. table:: ``mac-address`` Property
259259

260260
=========== ==============================================================
@@ -273,7 +273,7 @@ Network Class Binding
273273
``max-frame-size`` Property
274274
^^^^^^^^^^^^^^^^^^^^^^^^^^^
275275

276-
.. tabularcolumns:: l J
276+
.. tabularcolumns:: | l J |
277277
.. table:: ``max-frame-size`` Property
278278

279279
=========== ==============================================================
@@ -299,7 +299,7 @@ the network device class.
299299
``max-speed`` Property
300300
^^^^^^^^^^^^^^^^^^^^^^
301301

302-
.. tabularcolumns:: l J
302+
.. tabularcolumns:: | l J |
303303
.. table:: ``max-speed`` Property
304304

305305
=========== ==============================================================
@@ -314,7 +314,7 @@ the network device class.
314314
``phy-connection-type`` Property
315315
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
316316

317-
.. tabularcolumns:: l J
317+
.. tabularcolumns:: | l J |
318318
.. table:: ``max-speed`` Property
319319

320320
=========== ==============================================================
@@ -329,7 +329,7 @@ the network device class.
329329
Example ``phy-connection-type = “mii”;``
330330
=========== ==============================================================
331331

332-
.. tabularcolumns:: l J
332+
.. tabularcolumns:: | l J |
333333
.. table:: Defined values for the ``max-speed`` Property
334334

335335
===================================== ============
@@ -350,7 +350,7 @@ the network device class.
350350
``phy-handle`` Property
351351
^^^^^^^^^^^^^^^^^^^^^^^
352352

353-
.. tabularcolumns:: l J
353+
.. tabularcolumns:: | l J |
354354
.. table:: ``phy-handle`` Property
355355

356356
=========== ==============================================================
@@ -387,7 +387,7 @@ specifiers:
387387
2 = active high level sensitive type enabled
388388
3 = high to low edge sensitive type enabled
389389

390-
.. tabularcolumns:: l c l J
390+
.. tabularcolumns:: | l c l J |
391391
.. table:: Open-PIC properties
392392

393393
======================== ===== ===================== ===============================================
@@ -417,7 +417,7 @@ probed for devices. The devices on the bus can be accessed directly
417417
without additional configuration required. This type of bus is
418418
represented as a node with a compatible value of “simple-bus”.
419419

420-
.. tabularcolumns:: l c l J
420+
.. tabularcolumns:: | l c l J |
421421
.. table:: ``simple-bus`` Compatible Node Properties
422422

423423
======================== ===== ===================== ===============================================

source/devicenodes.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Root node
2222
The device tree has a single root node of which all other device nodes
2323
are descendants. The full path to the root node is ``/``.
2424

25-
.. tabularcolumns:: l c l J
25+
.. tabularcolumns:: | l c l J |
2626
.. table:: Root Node Properties
2727

2828
=================== ===== ================= ===============================================
@@ -70,7 +70,7 @@ a node in the device tree. For example, the property serial0 =
7070
Alias names shall be a lowercase text strings of 1 to 31 characters from
7171
the following set of characters.
7272

73-
.. tabularcolumns:: c p{8cm}
73+
.. tabularcolumns:: | c p{8cm} |
7474
.. table:: Valid characters for alias names
7575

7676
========= ================
@@ -130,7 +130,7 @@ memory reservations) as WIMG = 0b001x. That is:
130130

131131
If the VLE storage attribute is supported, with VLE=0.
132132

133-
.. tabularcolumns:: l c l J
133+
.. tabularcolumns:: | l c l J |
134134
.. table:: ``/memory`` Node Properties
135135

136136
======================= ===== ========================= ===============================================
@@ -204,7 +204,7 @@ time. It shall be a child of the root node.
204204

205205
The node name (see :ref:`sect-node-names`) shall be ``/chosen``.
206206

207-
.. tabularcolumns:: l c l J
207+
.. tabularcolumns:: | l c l J |
208208
.. table:: ``/chosen`` Node Properties
209209

210210
======================= ===== ===================== ===============================================
@@ -257,7 +257,7 @@ which represent the systems CPUs.
257257

258258
The node name (see :ref:`sect-node-names`) shall be cpus.
259259

260-
.. tabularcolumns:: l c l J
260+
.. tabularcolumns:: | l c l J |
261261
.. table:: ``/cpus`` Node Properties
262262

263263
======================= ===== ===================== ===============================================
@@ -315,7 +315,7 @@ The following table describes the general properties of CPU nodes. Some
315315
of the properties described in :numref:`table-cpu-node-props` are select
316316
standard properties with specific applicable detail.
317317

318-
.. tabularcolumns:: p{2.5cm} p{1cm} p{2cm} p{9.5cm}
318+
.. tabularcolumns:: | p{2.5cm} p{1cm} p{2cm} p{8.5cm} |
319319
.. _table-cpu-node-props:
320320
.. table:: ``/cpus/cpu*`` Node General Properties
321321
:class: longtable
@@ -436,7 +436,7 @@ standard properties with specific applicable detail.
436436
:ref:`sect-standard-properties`) are allowed but are optional.
437437

438438

439-
.. tabularcolumns:: p{2.5cm} p{1cm} p{2cm} p{9.5cm}
439+
.. tabularcolumns:: | p{2.5cm} p{1cm} p{2cm} p{9.5cm} |
440440
.. table:: ``/cpus/cpu*`` Node Power ISA Properties
441441
:class: longtable
442442

@@ -504,7 +504,7 @@ The following properties of a cpu node describe the translate look-aside
504504
buffer in the processor’s MMU.
505505

506506

507-
.. tabularcolumns:: l c l J
507+
.. tabularcolumns:: | l c l J |
508508
.. table:: ``/cpu/cpu*`` Node Power ISA TLB Properties
509509

510510
======================= ===== ===================== ===============================================
@@ -547,7 +547,7 @@ Internal (L1) Cache Properties
547547
The following properties of a cpu node describe the processor’s internal
548548
(L1) cache.
549549

550-
.. tabularcolumns:: l c l J
550+
.. tabularcolumns:: | l c l J |
551551
.. table:: ``/cpu/cpu*`` Node Power ISA Cache Properties
552552

553553
======================= ===== ===================== ===============================================
@@ -659,7 +659,7 @@ appropriate location in the device tree.
659659
Multiple-level and shared caches are represented with the properties in
660660
Table 3-9. The L1 cache properties are described in Table 3-8.
661661

662-
.. tabularcolumns:: l c l J
662+
.. tabularcolumns:: | l c l J |
663663
.. table:: ``/cpu/cpu*/l?-cache`` Node Power ISA Multiple-level and Shared Cache Properties
664664

665665
======================= ===== ===================== ===============================================

source/devicetree-basics.rst

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ The *node-name* component specifies the name of the node. It shall be 1
113113
to 31 characters in length and consist solely of characters from the set
114114
of characters in :numref:`node-name-characters`.
115115

116-
.. tabularcolumns:: c p{8cm}
116+
.. tabularcolumns:: | c p{8cm} |
117117
.. _node-name-characters:
118118
.. table:: Valid characters for node names
119119

@@ -256,7 +256,7 @@ Property Names
256256
Property names are strings of 1 to 31 characters from the characters show in
257257
:numref:`property-name-characters`
258258

259-
.. tabularcolumns:: c p{8cm}
259+
.. tabularcolumns:: | c p{8cm} |
260260
.. _property-name-characters:
261261
.. table:: Valid characters for property names
262262

@@ -296,7 +296,7 @@ sufficiently descriptive.
296296

297297
:numref:`property-values-table` describes the set of basic value types defined by the |spec|.
298298

299-
.. tabularcolumns:: p{4cm} p{12cm}
299+
.. tabularcolumns:: | p{4cm} p{12cm} |
300300
.. _property-values-table:
301301
.. table:: Property values
302302
:class: longtable
@@ -497,34 +497,35 @@ Value type: ``<string>``
497497

498498
Description:
499499

500-
The *status* property indicates the operational status of a device.
501-
Valid values are listed and defined in the following table.
502-
503-
.. tabularcolumns:: l J
504-
.. table:: Values for status property
505-
506-
============== ==============================================================
507-
Value Description
508-
============== ==============================================================
509-
``"okay"`` Indicates the device is operational
510-
-------------- --------------------------------------------------------------
511-
``"disabled"`` Indicates that the device is not presently operational, but it
512-
might become operational in the future (for example, something
513-
is not plugged in, or switched off).
514-
515-
Refer to the device binding for details on what disabled means
516-
for a given device.
517-
-------------- --------------------------------------------------------------
518-
``"fail"`` Indicates that the device is not operational. A serious error
519-
was detected in the device, and it is unlikely to become
520-
operational without repair.
521-
-------------- --------------------------------------------------------------
522-
``"fail-sss"`` Indicates that the device is not operational. A serious error
523-
was detected in the device and it is unlikely to become
524-
operational without repair. The sss portion of the value is
525-
specific to the device and indicates the error condition
526-
detected.
527-
============== ==============================================================
500+
The ``status`` property indicates the operational status of a device.
501+
Valid values are listed and defined in :numref:`table-prop-status-values`.
502+
503+
.. tabularcolumns:: | l J |
504+
.. _table-prop-status-values:
505+
.. table:: Values for status property
506+
507+
============== ==============================================================
508+
Value Description
509+
============== ==============================================================
510+
``"okay"`` Indicates the device is operational
511+
-------------- --------------------------------------------------------------
512+
``"disabled"`` Indicates that the device is not presently operational, but it
513+
might become operational in the future (for example, something
514+
is not plugged in, or switched off).
515+
516+
Refer to the device binding for details on what disabled means
517+
for a given device.
518+
-------------- --------------------------------------------------------------
519+
``"fail"`` Indicates that the device is not operational. A serious error
520+
was detected in the device, and it is unlikely to become
521+
operational without repair.
522+
-------------- --------------------------------------------------------------
523+
``"fail-sss"`` Indicates that the device is not operational. A serious error
524+
was detected in the device and it is unlikely to become
525+
operational without repair. The sss portion of the value is
526+
specific to the device and indicates the error condition
527+
detected.
528+
============== ==============================================================
528529

529530
#address-cells and #size-cells
530531
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)