Skip to content

Commit 2e16e00

Browse files
tohojotohojo
committed
Rebuild man pages
Export now uses spaces for indentation. Signed-off-by: Toke Høiland-Jørgensen <[email protected]>
1 parent d6d925a commit 2e16e00

File tree

4 files changed

+128
-128
lines changed

4 files changed

+128
-128
lines changed

‎lib/libxdp/libxdp.3

+35-35
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ program that is already loaded into the kernel:
5555
.RS
5656
.nf
5757
\fCstruct xdp_program *xdp_program__from_bpf_obj(struct bpf_object *obj,
58-
const char *section_name);
58+
const char *section_name);
5959
struct xdp_program *xdp_program__find_file(const char *filename,
60-
const char *section_name,
61-
struct bpf_object_open_opts *opts);
60+
const char *section_name,
61+
struct bpf_object_open_opts *opts);
6262
struct xdp_program *xdp_program__open_file(const char *filename,
63-
const char *section_name,
64-
struct bpf_object_open_opts *opts);
63+
const char *section_name,
64+
struct bpf_object_open_opts *opts);
6565
struct xdp_program *xdp_program__from_fd(int fd);
6666
struct xdp_program *xdp_program__from_id(__u32 prog_id);
6767
struct xdp_program *xdp_program__from_pin(const char *pin_path);
@@ -139,9 +139,9 @@ follows:
139139
#include <xdp/xdp_helpers.h>
140140

141141
struct {
142-
__uint(priority, 10);
143-
__uint(XDP_PASS, 1);
144-
__uint(XDP_DROP, 1);
142+
__uint(priority, 10);
143+
__uint(XDP_PASS, 1);
144+
__uint(XDP_DROP, 1);
145145
} XDP_RUN_CONFIG(my_xdp_func);
146146
\fP
147147
.fi
@@ -167,15 +167,15 @@ attachment.
167167
.nf
168168
\fCunsigned int xdp_program__run_prio(const struct xdp_program *xdp_prog);
169169
int xdp_program__set_run_prio(struct xdp_program *xdp_prog,
170-
unsigned int run_prio);
170+
unsigned int run_prio);
171171
bool xdp_program__chain_call_enabled(const struct xdp_program *xdp_prog,
172-
enum xdp_action action);
172+
enum xdp_action action);
173173
int xdp_program__set_chain_call_enabled(struct xdp_program *prog,
174-
unsigned int action,
175-
bool enabled);
174+
unsigned int action,
175+
bool enabled);
176176
int xdp_program__print_chain_call_actions(const struct xdp_program *prog,
177-
char *buf,
178-
size_t buf_len);
177+
char *buf,
178+
size_t buf_len);
179179
\fP
180180
.fi
181181
.RE
@@ -204,7 +204,7 @@ looks like this:
204204
.nf
205205
\fCstruct xdp_multiprog *xdp_multiprog__get_from_ifindex(int ifindex);
206206
struct xdp_program *xdp_multiprog__next_prog(const struct xdp_program *prog,
207-
const struct xdp_multiprog *mp);
207+
const struct xdp_multiprog *mp);
208208
void xdp_multiprog__close(struct xdp_multiprog *mp);
209209
int xdp_multiprog__detach(struct xdp_multiprog *mp, int ifindex);
210210
enum xdp_attach_mode xdp_multiprog__attach_mode(const struct xdp_multiprog *mp);
@@ -307,29 +307,29 @@ function.
307307
.RS
308308
.nf
309309
\fCint xsk_umem__create(struct xsk_umem **umem,
310-
void *umem_area, __u64 size,
311-
struct xsk_ring_prod *fill,
312-
struct xsk_ring_cons *comp,
313-
const struct xsk_umem_config *config);
310+
void *umem_area, __u64 size,
311+
struct xsk_ring_prod *fill,
312+
struct xsk_ring_cons *comp,
313+
const struct xsk_umem_config *config);
314314
int xsk_umem__create_with_fd(struct xsk_umem **umem,
315-
int fd, void *umem_area, __u64 size,
316-
struct xsk_ring_prod *fill,
317-
struct xsk_ring_cons *comp,
318-
const struct xsk_umem_config *config);
315+
int fd, void *umem_area, __u64 size,
316+
struct xsk_ring_prod *fill,
317+
struct xsk_ring_cons *comp,
318+
const struct xsk_umem_config *config);
319319
int xsk_socket__create(struct xsk_socket **xsk,
320-
const char *ifname, __u32 queue_id,
321-
struct xsk_umem *umem,
322-
struct xsk_ring_cons *rx,
323-
struct xsk_ring_prod *tx,
324-
const struct xsk_socket_config *config);
320+
const char *ifname, __u32 queue_id,
321+
struct xsk_umem *umem,
322+
struct xsk_ring_cons *rx,
323+
struct xsk_ring_prod *tx,
324+
const struct xsk_socket_config *config);
325325
int xsk_socket__create_shared(struct xsk_socket **xsk_ptr,
326-
const char *ifname,
327-
__u32 queue_id, struct xsk_umem *umem,
328-
struct xsk_ring_cons *rx,
329-
struct xsk_ring_prod *tx,
330-
struct xsk_ring_prod *fill,
331-
struct xsk_ring_cons *comp,
332-
const struct xsk_socket_config *config);
326+
const char *ifname,
327+
__u32 queue_id, struct xsk_umem *umem,
328+
struct xsk_ring_cons *rx,
329+
struct xsk_ring_prod *tx,
330+
struct xsk_ring_prod *fill,
331+
struct xsk_ring_cons *comp,
332+
const struct xsk_socket_config *config);
333333
int xsk_umem__delete(struct xsk_umem *umem);
334334
void xsk_socket__delete(struct xsk_socket *xsk);
335335
\fP

‎xdp-bench/xdp-bench.8

+44-44
Original file line numberDiff line numberDiff line change
@@ -683,70 +683,70 @@ Extended output mode displays at most the following fields:
683683
\fCFIELD DESCRIPTION
684684
receive Displays the number of packets received and errors encountered
685685

686-
Whenever an error or packet drop occurs, details of per CPU error
687-
and drop statistics will be expanded inline in terse mode.
688-
pkt/s - Packets received per second
689-
drop/s - Packets dropped per second
690-
error/s - Errors encountered per second
691-
redirect - Displays the number of packets successfully redirected
692-
Errors encountered are expanded under redirect_err field
693-
Note that passing -s to enable it has a per packet overhead
694-
redir/s - Packets redirected successfully per second
686+
Whenever an error or packet drop occurs, details of per CPU error
687+
and drop statistics will be expanded inline in terse mode.
688+
pkt/s - Packets received per second
689+
drop/s - Packets dropped per second
690+
error/s - Errors encountered per second
691+
redirect - Displays the number of packets successfully redirected
692+
Errors encountered are expanded under redirect_err field
693+
Note that passing -s to enable it has a per packet overhead
694+
redir/s - Packets redirected successfully per second
695695

696696

697697
redirect_err Displays the number of packets that failed redirection
698698

699-
The errno is expanded under this field with per CPU count
700-
The recognized errors are:
701-
EINVAL: Invalid redirection
702-
ENETDOWN: Device being redirected to is down
703-
EMSGSIZE: Packet length too large for device
704-
EOPNOTSUPP: Operation not supported
705-
ENOSPC: No space in ptr_ring of cpumap kthread
699+
The errno is expanded under this field with per CPU count
700+
The recognized errors are:
701+
EINVAL: Invalid redirection
702+
ENETDOWN: Device being redirected to is down
703+
EMSGSIZE: Packet length too large for device
704+
EOPNOTSUPP: Operation not supported
705+
ENOSPC: No space in ptr_ring of cpumap kthread
706706

707-
error/s - Packets that failed redirection per second
707+
error/s - Packets that failed redirection per second
708708

709709

710710
enqueue to cpu N Displays the number of packets enqueued to bulk queue of CPU N
711-
Expands to cpu:FROM->N to display enqueue stats for each CPU enqueuing to CPU N
712-
Received packets can be associated with the CPU redirect program is enqueuing
713-
packets to.
714-
pkt/s - Packets enqueued per second from other CPU to CPU N
715-
drop/s - Packets dropped when trying to enqueue to CPU N
716-
bulk-avg - Average number of packets processed for each event
711+
Expands to cpu:FROM->N to display enqueue stats for each CPU enqueuing to CPU N
712+
Received packets can be associated with the CPU redirect program is enqueuing
713+
packets to.
714+
pkt/s - Packets enqueued per second from other CPU to CPU N
715+
drop/s - Packets dropped when trying to enqueue to CPU N
716+
bulk-avg - Average number of packets processed for each event
717717

718718

719719
kthread Displays the number of packets processed in CPUMAP kthread for each CPU
720-
Packets consumed from ptr_ring in kthread, and its xdp_stats (after calling
721-
CPUMAP bpf prog) are expanded below this. xdp_stats are expanded as a total and
722-
then per-CPU to associate it to each CPU's pinned CPUMAP kthread.
723-
pkt/s - Packets consumed per second from ptr_ring
724-
drop/s - Packets dropped per second in kthread
725-
sched - Number of times kthread called schedule()
720+
Packets consumed from ptr_ring in kthread, and its xdp_stats (after calling
721+
CPUMAP bpf prog) are expanded below this. xdp_stats are expanded as a total and
722+
then per-CPU to associate it to each CPU's pinned CPUMAP kthread.
723+
pkt/s - Packets consumed per second from ptr_ring
724+
drop/s - Packets dropped per second in kthread
725+
sched - Number of times kthread called schedule()
726726

727-
xdp_stats (also expands to per-CPU counts)
728-
pass/s - XDP_PASS count for CPUMAP program execution
729-
drop/s - XDP_DROP count for CPUMAP program execution
730-
redir/s - XDP_REDIRECT count for CPUMAP program execution
727+
xdp_stats (also expands to per-CPU counts)
728+
pass/s - XDP_PASS count for CPUMAP program execution
729+
drop/s - XDP_DROP count for CPUMAP program execution
730+
redir/s - XDP_REDIRECT count for CPUMAP program execution
731731

732732

733733
xdp_exception Displays xdp_exception tracepoint events
734734

735-
This can occur due to internal driver errors, unrecognized
736-
XDP actions and due to explicit user trigger by use of XDP_ABORTED
737-
Each action is expanded below this field with its count
738-
hit/s - Number of times the tracepoint was hit per second
735+
This can occur due to internal driver errors, unrecognized
736+
XDP actions and due to explicit user trigger by use of XDP_ABORTED
737+
Each action is expanded below this field with its count
738+
hit/s - Number of times the tracepoint was hit per second
739739

740740

741741
devmap_xmit Displays devmap_xmit tracepoint events
742742

743-
This tracepoint is invoked for successful transmissions on output
744-
device but these statistics are not available for generic XDP mode,
745-
hence they will be omitted from the output when using SKB mode
746-
xmit/s - Number of packets that were transmitted per second
747-
drop/s - Number of packets that failed transmissions per second
748-
drv_err/s - Number of internal driver errors per second
749-
bulk-avg - Average number of packets processed for each event
743+
This tracepoint is invoked for successful transmissions on output
744+
device but these statistics are not available for generic XDP mode,
745+
hence they will be omitted from the output when using SKB mode
746+
xmit/s - Number of packets that were transmitted per second
747+
drop/s - Number of packets that failed transmissions per second
748+
drv_err/s - Number of internal driver errors per second
749+
bulk-avg - Average number of packets processed for each event
750750
\fP
751751
.fi
752752
.RE

‎xdp-loader/xdp-loader.8

+5-5
Original file line numberDiff line numberDiff line change
@@ -263,11 +263,11 @@ definition in the program, something like:
263263
.RS
264264
.nf
265265
\fCstruct {
266-
__uint(type, BPF_MAP_TYPE_ARRAY);
267-
__uint(max_entries, 10);
268-
__type(key, __u32);
269-
__type(value, __u64);
270-
__uint(pinning, LIBBPF_PIN_BY_NAME);
266+
__uint(type, BPF_MAP_TYPE_ARRAY);
267+
__uint(max_entries, 10);
268+
__type(key, __u32);
269+
__type(value, __u64);
270+
__uint(pinning, LIBBPF_PIN_BY_NAME);
271271
} my_map SEC(".maps");
272272
\fP
273273
.fi

‎xdp-monitor/xdp-monitor.8

+44-44
Original file line numberDiff line numberDiff line change
@@ -90,70 +90,70 @@ Verbose output mode displays at most the following fields:
9090
\fCFIELD DESCRIPTION
9191
receive Displays the number of packets received and errors encountered
9292

93-
Whenever an error or packet drop occurs, details of per CPU error
94-
and drop statistics will be expanded inline in terse mode.
95-
pkt/s - Packets received per second
96-
drop/s - Packets dropped per second
97-
error/s - Errors encountered per second
98-
redirect - Displays the number of packets successfully redirected
99-
Errors encountered are expanded under redirect_err field
100-
Note that passing -s to enable it has a per packet overhead
101-
redir/s - Packets redirected successfully per second
93+
Whenever an error or packet drop occurs, details of per CPU error
94+
and drop statistics will be expanded inline in terse mode.
95+
pkt/s - Packets received per second
96+
drop/s - Packets dropped per second
97+
error/s - Errors encountered per second
98+
redirect - Displays the number of packets successfully redirected
99+
Errors encountered are expanded under redirect_err field
100+
Note that passing -s to enable it has a per packet overhead
101+
redir/s - Packets redirected successfully per second
102102

103103

104104
redirect_err Displays the number of packets that failed redirection
105105

106-
The errno is expanded under this field with per CPU count
107-
The recognized errors are:
108-
EINVAL: Invalid redirection
109-
ENETDOWN: Device being redirected to is down
110-
EMSGSIZE: Packet length too large for device
111-
EOPNOTSUPP: Operation not supported
112-
ENOSPC: No space in ptr_ring of cpumap kthread
106+
The errno is expanded under this field with per CPU count
107+
The recognized errors are:
108+
EINVAL: Invalid redirection
109+
ENETDOWN: Device being redirected to is down
110+
EMSGSIZE: Packet length too large for device
111+
EOPNOTSUPP: Operation not supported
112+
ENOSPC: No space in ptr_ring of cpumap kthread
113113

114-
error/s - Packets that failed redirection per second
114+
error/s - Packets that failed redirection per second
115115

116116

117117
enqueue to cpu N Displays the number of packets enqueued to bulk queue of CPU N
118-
Expands to cpu:FROM->N to display enqueue stats for each CPU enqueuing to CPU N
119-
Received packets can be associated with the CPU redirect program is enqueuing
120-
packets to.
121-
pkt/s - Packets enqueued per second from other CPU to CPU N
122-
drop/s - Packets dropped when trying to enqueue to CPU N
123-
bulk-avg - Average number of packets processed for each event
118+
Expands to cpu:FROM->N to display enqueue stats for each CPU enqueuing to CPU N
119+
Received packets can be associated with the CPU redirect program is enqueuing
120+
packets to.
121+
pkt/s - Packets enqueued per second from other CPU to CPU N
122+
drop/s - Packets dropped when trying to enqueue to CPU N
123+
bulk-avg - Average number of packets processed for each event
124124

125125

126126
kthread Displays the number of packets processed in CPUMAP kthread for each CPU
127-
Packets consumed from ptr_ring in kthread, and its xdp_stats (after calling
128-
CPUMAP bpf prog) are expanded below this. xdp_stats are expanded as a total and
129-
then per-CPU to associate it to each CPU's pinned CPUMAP kthread.
130-
pkt/s - Packets consumed per second from ptr_ring
131-
drop/s - Packets dropped per second in kthread
132-
sched - Number of times kthread called schedule()
127+
Packets consumed from ptr_ring in kthread, and its xdp_stats (after calling
128+
CPUMAP bpf prog) are expanded below this. xdp_stats are expanded as a total and
129+
then per-CPU to associate it to each CPU's pinned CPUMAP kthread.
130+
pkt/s - Packets consumed per second from ptr_ring
131+
drop/s - Packets dropped per second in kthread
132+
sched - Number of times kthread called schedule()
133133

134-
xdp_stats (also expands to per-CPU counts)
135-
pass/s - XDP_PASS count for CPUMAP program execution
136-
drop/s - XDP_DROP count for CPUMAP program execution
137-
redir/s - XDP_REDIRECT count for CPUMAP program execution
134+
xdp_stats (also expands to per-CPU counts)
135+
pass/s - XDP_PASS count for CPUMAP program execution
136+
drop/s - XDP_DROP count for CPUMAP program execution
137+
redir/s - XDP_REDIRECT count for CPUMAP program execution
138138

139139

140140
xdp_exception Displays xdp_exception tracepoint events
141141

142-
This can occur due to internal driver errors, unrecognized
143-
XDP actions and due to explicit user trigger by use of XDP_ABORTED
144-
Each action is expanded below this field with its count
145-
hit/s - Number of times the tracepoint was hit per second
142+
This can occur due to internal driver errors, unrecognized
143+
XDP actions and due to explicit user trigger by use of XDP_ABORTED
144+
Each action is expanded below this field with its count
145+
hit/s - Number of times the tracepoint was hit per second
146146

147147

148148
devmap_xmit Displays devmap_xmit tracepoint events
149149

150-
This tracepoint is invoked for successful transmissions on output
151-
device but these statistics are not available for generic XDP mode,
152-
hence they will be omitted from the output when using SKB mode
153-
xmit/s - Number of packets that were transmitted per second
154-
drop/s - Number of packets that failed transmissions per second
155-
drv_err/s - Number of internal driver errors per second
156-
bulk-avg - Average number of packets processed for each event
150+
This tracepoint is invoked for successful transmissions on output
151+
device but these statistics are not available for generic XDP mode,
152+
hence they will be omitted from the output when using SKB mode
153+
xmit/s - Number of packets that were transmitted per second
154+
drop/s - Number of packets that failed transmissions per second
155+
drv_err/s - Number of internal driver errors per second
156+
bulk-avg - Average number of packets processed for each event
157157
\fP
158158
.fi
159159
.RE

0 commit comments

Comments
 (0)