Skip to content

Commit 2bf7a67

Browse files
igsilyaigsilya
committed
support: Update man pages to v3.4.0.
Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
1 parent 3b52994 commit 2bf7a67

119 files changed

Lines changed: 4101 additions & 3736 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎support/dist-docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<html><head>
22
<meta charset="UTF-8"></head>
33
<link rel="stylesheet" type="text/css" href="style.css">
4-
<title>Open vSwitch 3.3.1 Documentation</title>
4+
<title>Open vSwitch 3.4.0 Documentation</title>
55
</head><body>
6-
<h1>Open vSwitch 3.3.1 Manpages</h1>
6+
<h1>Open vSwitch 3.4.0 Manpages</h1>
77
<table>
88
<tr><td>ovs-actions(7)</td><td><a href="ovs-actions.7.pdf">PDF</a>, <a href="ovs-actions.7.html">HTML</a>, <a href="ovs-actions.7.txt">plain text</a></td></tr>
99
<tr><td>ovs-appctl(8)</td><td><a href="ovs-appctl.8.pdf">PDF</a>, <a href="ovs-appctl.8.html">HTML</a>, <a href="ovs-appctl.8.txt">plain text</a></td></tr>

‎support/dist-docs/ovs-actions.7‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "OVS-ACTIONS" "7" "Jun 07, 2024" "3.3" "Open vSwitch"
30+
.TH "OVS-ACTIONS" "7" "Aug 15, 2024" "3.4" "Open vSwitch"
3131
.SH NAME
3232
ovs-actions \- OpenFlow actions and instructions with Open vSwitch extensions
3333
.SH INTRODUCTION
@@ -1804,8 +1804,7 @@ The L4 \fBport\fP or range \fBport1\-port2\fP from which the translated port
18041804
should be selected. When a port range is specified, fallback to
18051805
ephemeral ports does not happen, else, it will. The port number
18061806
selection can be informed by the optional \fBrandom\fP and \fBhash\fP flags
1807-
described below. The userspace datapath only supports the \fBhash\fP
1808-
behavior.
1807+
described below.
18091808
.UNINDENT
18101809
.UNINDENT
18111810
.UNINDENT
@@ -2594,13 +2593,17 @@ The number of sampled packets out of 65535. Must be greater or equal to 1.
25942593
The unsigned 32\-bit integer identifier of the set of sample collectors to
25952594
send sampled packets to. Defaults to 0.
25962595
.TP
2597-
.B \fBobs_domain_id=\fP\fIid\fP
2596+
.B \fBobs_domain_id=\fP\fIvalue\fP
25982597
When sending samples to IPFIX collectors, the unsigned 32\-bit integer
2599-
Observation Domain ID sent in every IPFIX flow record. Defaults to 0.
2598+
Observation Domain ID sent in every IPFIX flow record. The \fIvalue\fP may
2599+
be specified as a 32\-bit integer or a field or subfield in the syntax
2600+
described under \fI\%Field Specifications\fP above. Defaults to 0.
26002601
.TP
2601-
.B \fBobs_point_id=\fP\fIid\fP
2602+
.B \fBobs_point_id=\fP\fIvalue\fP
26022603
When sending samples to IPFIX collectors, the unsigned 32\-bit integer
2603-
Observation Point ID sent in every IPFIX flow record. Defaults to 0.
2604+
Observation Point ID sent in every IPFIX flow record. The \fIvalue\fP may
2605+
be specified as a 32\-bit integer or a field or subfield in the syntax
2606+
described under \fI\%Field Specifications\fP above. Defaults to 0.
26042607
.TP
26052608
.B \fBsampling_port=\fP\fIport\fP
26062609
Sample packets on \fIport\fP, which should be the ingress or egress port. This
@@ -2630,6 +2633,9 @@ collector sets.
26302633
.TP
26312634
\fBConformance\fP
26322635
This action is an OpenFlow extension added in Open vSwitch 2.4.
2636+
.sp
2637+
Support for subfields in \fIobs_domain_id\fP and \fIobs_point_id\fP was added in
2638+
Open vSwitch 3.4.
26332639
.UNINDENT
26342640
.SH INSTRUCTIONS
26352641
.sp
@@ -2782,6 +2788,6 @@ OpenFlow 1.1 introduced \fBgoto_table\fP\&. Open vSwitch 2.1 added support for
27822788
.SH AUTHOR
27832789
The Open vSwitch Development Community
27842790
.SH COPYRIGHT
2785-
2016-2021, The Open vSwitch Development Community
2791+
2016-2024, The Open vSwitch Development Community
27862792
.\" Generated by docutils manpage writer.
27872793
.

‎support/dist-docs/ovs-actions.7.html‎

Lines changed: 205 additions & 199 deletions
Large diffs are not rendered by default.

‎support/dist-docs/ovs-actions.7.pdf‎

172 Bytes
Binary file not shown.

‎support/dist-docs/ovs-actions.7.txt‎

Lines changed: 205 additions & 199 deletions
Large diffs are not rendered by default.

‎support/dist-docs/ovs-appctl.8‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "OVS-APPCTL" "8" "Jun 07, 2024" "3.3" "Open vSwitch"
30+
.TH "OVS-APPCTL" "8" "Aug 15, 2024" "3.4" "Open vSwitch"
3131
.SH NAME
3232
ovs-appctl \- utility for configuring running Open vSwitch daemons
3333
.SH SYNOPSIS
3434
.sp
3535
\fBovs\-appctl\fP
3636
[\fB\-\-target=\(ga\(ga<target> | \(ga\(ga\-t\fP <target>]
3737
[\fB\-\-timeout=\(ga\(ga<secs> | \(ga\(ga\-T\fP <secs>]
38+
[\fB\-\-format=\(ga\(ga<format> | \(ga\(ga\-f\fP <format>]
39+
[\fB\-\-pretty\fP]
3840
<command> [<arg>…]
3941
.sp
4042
\fBovs\-appctl \-\-help\fP
@@ -92,6 +94,32 @@ By default, or with a <secs> of \fB0\fP, \fBovs\-appctl\fP waits forever to
9294
connect to the daemon and receive a response. This option limits
9395
runtime to approximately <secs> seconds. If the timeout expires,
9496
\fBovs\-appctl\fP exits with a \fBSIGALRM\fP signal.
97+
.IP \(bu 2
98+
\fB\-f <format>\fP or \fB\-\-format=<format>\fP
99+
.sp
100+
Tells \fBovs\-appctl\fP which output format to use. By default, or with a
101+
<format> of \fBtext\fP, \fBovs\-appctl\fP will print plain\-text for humans.
102+
When <format> is \fBjson\fP, \fBovs\-appctl\fP will return a JSON document.
103+
When \fBjson\fP is requested, but a command has not implemented JSON
104+
output, the plain\-text output will be wrapped in a provisional JSON
105+
document with the following structure:
106+
.INDENT 2.0
107+
.INDENT 3.5
108+
.sp
109+
.nf
110+
.ft C
111+
{\(dqreply\-format\(dq:\(dqplain\(dq,\(dqreply\(dq:\(dq$PLAIN_TEXT_HERE\(dq}
112+
.ft P
113+
.fi
114+
.UNINDENT
115+
.UNINDENT
116+
.IP \(bu 2
117+
\fB\-\-pretty\fP
118+
.sp
119+
By default, JSON output is printed as compactly as possible. This option
120+
causes JSON in output to be printed in a more readable fashion. For
121+
example, members of objects and elements of arrays are printed one
122+
per line, with indentation. Requires \fB\-\-format=json\fP\&.
95123
.UNINDENT
96124
.SH COMMON COMMANDS
97125
.sp
@@ -366,6 +394,6 @@ Prints version information to the console.
366394
.SH AUTHOR
367395
The Open vSwitch Development Community
368396
.SH COPYRIGHT
369-
2016-2021, The Open vSwitch Development Community
397+
2016-2024, The Open vSwitch Development Community
370398
.\" Generated by docutils manpage writer.
371399
.

0 commit comments

Comments
 (0)