[ovs-git] [openvswitch/ovs] 902323: nroff: Improve formatting of ASCII diagrams.

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/openvswitch/ovs
  Commit: 902323d32ed7656b58c9c37d5ac9ebe7986b0a68
      https://github.com/openvswitch/ovs/commit/902323d32ed7656b58c9c37d5ac9ebe7986b0a68
  Author: Ben Pfaff <blp at ovn.org>
  Date:   2017-01-25 (Wed, 25 Jan 2017)

  Changed paths:
    M python/build/nroff.py

  Log Message:
  -----------
  nroff: Improve formatting of ASCII diagrams.

This makes diagrams in ASCII output look about as good as one might
reasonably expect, so that in ovn-architecture(7), for example, this:

. 9 bits: reserved (0)
. 15 bits: ingress port
. 16 bits: egress port
. 24 bits: datapath

now gets formatted as:

    9          15          16         24
+--------+------------+-----------+--------+
|reserved|ingress port|egress port|datapath|
+--------+------------+-----------+--------+
    0

which isn't perfect but certainly more evocative than a bulleted list.

This will be more useful in upcoming commits that start using diagrams more
frequently.

Signed-off-by: Ben Pfaff <blp at ovn.org>


  Commit: 96fee5e0a2a085367e27c79e57f70be2abee683a
      https://github.com/openvswitch/ovs/commit/96fee5e0a2a085367e27c79e57f70be2abee683a
  Author: Ben Pfaff <blp at ovn.org>
  Date:   2017-01-25 (Wed, 25 Jan 2017)

  Changed paths:
    M Documentation/ref/index.rst
    M build-aux/extract-ofp-fields
    M include/openvswitch/meta-flow.h
    M lib/automake.mk
    A lib/meta-flow.xml
    M ovn/ovn-architecture.7.xml
    M ovn/utilities/ovn-trace.8.xml
    M python/build/nroff.py
    M utilities/ovs-ofctl.8.in
    M vswitchd/vswitch.xml

  Log Message:
  -----------
  ovs-fields: New manpage to document Open vSwitch and OpenFlow fields.

There is still plenty of opportunity for improvement, but this new
ovs-fields(7) manpage is much more comprehensive than ovs-ofctl(8)
could be.

Signed-off-by: Ben Pfaff <blp at ovn.org>
Acked-by: Justin Pettit <jpettit at ovn.org>


Compare: https://github.com/openvswitch/ovs/compare/bef503e8c094...96fee5e0a2a0