Skip to content

Commit 982fea3

Browse files
committed
man pages: Whitespace changes
Newer Emacs versions changed the org-mode man page export code, which results in whitespace changes to all generated man pages. Keep these in a separate commit to avoid bloating the subsequent version bump commit. Signed-off-by: Toke Høiland-Jørgensen <[email protected]>
1 parent 8ecf796 commit 982fea3

File tree

8 files changed

+60
-297
lines changed

8 files changed

+60
-297
lines changed

Diff for: lib/libxdp/libxdp.3

-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.TH "libxdp" "3" "January 14, 2025" "v1.5.2" "libxdp - library for loading XDP programs"
2-
32
.SH "NAME"
43
libxdp \- library for attaching XDP programs and using AF_XDP sockets
54
.SH "SYNOPSIS"
@@ -22,7 +21,6 @@ well as reading and writing packets from these sockets.
2221
.PP
2322
Some of the functionality provided by libxdp depends on particular kernel
2423
features; see the "Kernel feature compatibility" section below for details.
25-
2624
.SS "Using libxdp from an application"
2725
.PP
2826
Basic usage of libxdp from an application is quite straight forward. The
@@ -101,12 +99,10 @@ that program will have to be detached from the interface before libxdp can
10199
attach a new one. This can be done by calling \fIxdp_program__detach()\fP with a
102100
reference to the loaded program; but note that this will of course break any
103101
application relying on that other XDP program to be present.
104-
105102
.SH "Program metadata"
106103
.PP
107104
To support multiple XDP programs on the same interface, libxdp uses two pieces
108105
of metadata for each XDP program: Run priority and chain call actions.
109-
110106
.SS "Run priority"
111107
.PP
112108
This is the priority of the program and is a simple integer used
@@ -116,7 +112,6 @@ for this, while programs that want to run later (such as a packet forwarder or
116112
counter) should set higher values. Note that later programs are only run if the
117113
previous programs end with a return code that is part of its chain call actions
118114
(see below). If not specified, the default priority value is 50.
119-
120115
.SS "Chain call actions"
121116
.PP
122117
These are the program return codes that the program indicate for packets that
@@ -125,7 +120,6 @@ programs in the call chain will be run, whereas if it returns any other action,
125120
processing will be interrupted, and the XDP dispatcher will return the verdict
126121
immediately. If not set, this defaults to just XDP_PASS, which is likely the
127122
value most programs should use.
128-
129123
.SS "Specifying metadata"
130124
.PP
131125
The metadata outlined above is specified as BTF information embedded in the ELF
@@ -154,7 +148,6 @@ In a source file with multiple XDP programs in the same file, a definition like
154148
the above can be included for each program (main XDP function). Any program that
155149
does not specify any config information will use the default values outlined
156150
above.
157-
158151
.SS "Inspecting and modifying metadata"
159152
.PP
160153
\fIlibxdp\fP exposes the following functions that an application can use to inspect
@@ -179,7 +172,6 @@ int xdp_program__print_chain_call_actions(const struct xdp_program *prog,
179172
\fP
180173
.fi
181174
.RE
182-
183175
.SH "The dispatcher program"
184176
.PP
185177
To support multiple non-offloaded programs on the same network interface,
@@ -229,7 +221,6 @@ be acquired using \fIxdp_multiprog_hw_prog()\fP. Function
229221
\fIxdp_multiprog__attach_mode()\fP returns the attach mode of the non-offloaded
230222
program, whether an offloaded program is attached should be checked through
231223
\fIxdp_multiprog_hw_prog()\fP.
232-
233224
.SS "Pinning in bpffs"
234225
.PP
235226
The kernel will automatically detach component programs from the dispatcher once
@@ -258,7 +249,6 @@ libxdp will consult the environment variable \fILIBXDP_BPFFS_AUTOMOUNT\fP. If th
258249
is set to \fI1\fP, libxdp will attempt to automount a bpffs. If not, libxdp will
259250
fall back to loading a single program without a dispatcher, as if the kernel did
260251
not support the features needed for multiprog attachment.
261-
262252
.SH "Using AF_XDP sockets"
263253
.PP
264254
Libxdp implements helper functions for configuring AF_XDP sockets as
@@ -282,7 +272,6 @@ and the documentation in the Linux kernel
282272
For an example on how to use the interface, take a look at the AF_XDP-example
283273
and AF_XDP-forwarding programs in the bpf-examples repository:
284274
\fIhttps://github.com/xdp-project/bpf-examples\fP.
285-
286275
.SS "Control path"
287276
.PP
288277
Libxdp provides helper functions for creating and destroying umems and
@@ -377,7 +366,6 @@ beforehand with socket(AF_XDP, SOCK_RAW, 0) and passed to a non-privileged
377366
process. This socket can be used in xsk_umem__create_opts() and later in
378367
xsk_socket__create() with created umem. xsk_socket__create_shared() would
379368
still require privileges for AF_XDP socket creation.
380-
381369
.SS "Data path"
382370
.PP
383371
For performance reasons, all the data path functions are static inline
@@ -468,7 +456,6 @@ operation than the other two.
468456
For an example on how to use all these APIs, take a look at the AF_XDP-example
469457
and AF_XDP-forwarding programs in the bpf-examples repository:
470458
\fIhttps://github.com/xdp-project/bpf-examples\fP.
471-
472459
.SH "Kernel and BPF program feature compatibility"
473460
.PP
474461
The features exposed by libxdp relies on certain kernel versions and BPF
@@ -513,11 +500,9 @@ Finally, XDP programs loaded using the multiprog facility must include type
513500
information (using the BPF Type Format, BTF). To get this, compile the programs
514501
with a recent version of Clang/LLVM (version 10+), and enable debug information
515502
when compiling (using the \fI\-g\fP option).
516-
517503
.SH "BUGS"
518504
.PP
519505
Please report any bugs on Github: \fIhttps://github.com/xdp-project/xdp-tools/issues\fP
520-
521506
.SH "AUTHORS"
522507
.PP
523508
libxdp and this man page were written by Toke

0 commit comments

Comments
 (0)