History

bpf: fix recurring typo in documentation for BPF helpers

"Underlaying packet buffer" should be an "underlying" one, in the warning about invalidated data and data_end pointers. Through copy-and-paste, the typo occurred no fewer than 19 times in the documentation. Let's fix it.

Quentin Monnet committed 7 years ago

Commit 32e7dc21 parent 748c7c81 file · +19 −19Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/linux/bpf.h+19−19
@@ -629,7 +629,7 @@ union bpf_attr { · 628 unmodified lines
629629 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
630630 * **->swhash** and *skb*\ **->l4hash** to 0).
631631 *
632− * A call to this helper is susceptible to change the underlaying
632+ * A call to this helper is susceptible to change the underlying
633633 * packet buffer. Therefore, at load time, all checks on pointers
634634 * previously done by the verifier are invalidated and must be
635635 * performed again, if the helper is used in combination with
@@ -654,7 +654,7 @@ union bpf_attr { · 18 unmodified lines
654654 * flexibility and can handle sizes larger than 2 or 4 for the
655655 * checksum to update.
656656 *
657− * A call to this helper is susceptible to change the underlaying
657+ * A call to this helper is susceptible to change the underlying
658658 * packet buffer. Therefore, at load time, all checks on pointers
659659 * previously done by the verifier are invalidated and must be
660660 * performed again, if the helper is used in combination with
@@ -686,7 +686,7 @@ union bpf_attr { · 25 unmodified lines
686686 * flexibility and can handle sizes larger than 2 or 4 for the
687687 * checksum to update.
688688 *
689− * A call to this helper is susceptible to change the underlaying
689+ * A call to this helper is susceptible to change the underlying
690690 * packet buffer. Therefore, at load time, all checks on pointers
691691 * previously done by the verifier are invalidated and must be
692692 * performed again, if the helper is used in combination with
@@ -741,7 +741,7 @@ union bpf_attr { · 48 unmodified lines
741741 * efficient, but it is handled through an action code where the
742742 * redirection happens only after the eBPF program has returned.
743743 *
744− * A call to this helper is susceptible to change the underlaying
744+ * A call to this helper is susceptible to change the underlying
745745 * packet buffer. Therefore, at load time, all checks on pointers
746746 * previously done by the verifier are invalidated and must be
747747 * performed again, if the helper is used in combination with
@@ -806,7 +806,7 @@ union bpf_attr { · 58 unmodified lines
806806 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
807807 * be **ETH_P_8021Q**.
808808 *
809− * A call to this helper is susceptible to change the underlaying
809+ * A call to this helper is susceptible to change the underlying
810810 * packet buffer. Therefore, at load time, all checks on pointers
811811 * previously done by the verifier are invalidated and must be
812812 * performed again, if the helper is used in combination with
@@ -818,7 +818,7 @@ union bpf_attr { · 5 unmodified lines
818818 * Description
819819 * Pop a VLAN header from the packet associated to *skb*.
820820 *
821− * A call to this helper is susceptible to change the underlaying
821+ * A call to this helper is susceptible to change the underlying
822822 * packet buffer. Therefore, at load time, all checks on pointers
823823 * previously done by the verifier are invalidated and must be
824824 * performed again, if the helper is used in combination with
@@ -1168,7 +1168,7 @@ union bpf_attr { · 343 unmodified lines
11681168 * All values for *flags* are reserved for future usage, and must
11691169 * be left at zero.
11701170 *
1171− * A call to this helper is susceptible to change the underlaying
1171+ * A call to this helper is susceptible to change the underlying
11721172 * packet buffer. Therefore, at load time, all checks on pointers
11731173 * previously done by the verifier are invalidated and must be
11741174 * performed again, if the helper is used in combination with
@@ -1281,7 +1281,7 @@ union bpf_attr { · 106 unmodified lines
12811281 * implicitly linearizes, unclones and drops offloads from the
12821282 * *skb*.
12831283 *
1284− * A call to this helper is susceptible to change the underlaying
1284+ * A call to this helper is susceptible to change the underlying
12851285 * packet buffer. Therefore, at load time, all checks on pointers
12861286 * previously done by the verifier are invalidated and must be
12871287 * performed again, if the helper is used in combination with
@@ -1317,7 +1317,7 @@ union bpf_attr { · 29 unmodified lines
13171317 * **bpf_skb_pull_data()** to effectively unclone the *skb* from
13181318 * the very beginning in case it is indeed cloned.
13191319 *
1320− * A call to this helper is susceptible to change the underlaying
1320+ * A call to this helper is susceptible to change the underlying
13211321 * packet buffer. Therefore, at load time, all checks on pointers
13221322 * previously done by the verifier are invalidated and must be
13231323 * performed again, if the helper is used in combination with
@@ -1369,7 +1369,7 @@ union bpf_attr { · 45 unmodified lines
13691369 * All values for *flags* are reserved for future usage, and must
13701370 * be left at zero.
13711371 *
1372− * A call to this helper is susceptible to change the underlaying
1372+ * A call to this helper is susceptible to change the underlying
13731373 * packet buffer. Therefore, at load time, all checks on pointers
13741374 * previously done by the verifier are invalidated and must be
13751375 * performed again, if the helper is used in combination with
@@ -1384,7 +1384,7 @@ union bpf_attr { · 8 unmodified lines
13841384 * can be used to prepare the packet for pushing or popping
13851385 * headers.
13861386 *
1387− * A call to this helper is susceptible to change the underlaying
1387+ * A call to this helper is susceptible to change the underlying
13881388 * packet buffer. Therefore, at load time, all checks on pointers
13891389 * previously done by the verifier are invalidated and must be
13901390 * performed again, if the helper is used in combination with
@@ -1531,7 +1531,7 @@ union bpf_attr { · 140 unmodified lines
15311531 * Use with ENCAP_L3/L4 flags to further specify the tunnel
15321532 * type; **len** is the length of the inner MAC header.
15331533 *
1534− * A call to this helper is susceptible to change the underlaying
1534+ * A call to this helper is susceptible to change the underlying
15351535 * packet buffer. Therefore, at load time, all checks on pointers
15361536 * previously done by the verifier are invalidated and must be
15371537 * performed again, if the helper is used in combination with
@@ -1610,7 +1610,7 @@ union bpf_attr { · 72 unmodified lines
16101610 * more flexibility as the user is free to store whatever meta
16111611 * data they need.
16121612 *
1613− * A call to this helper is susceptible to change the underlaying
1613+ * A call to this helper is susceptible to change the underlying
16141614 * packet buffer. Therefore, at load time, all checks on pointers
16151615 * previously done by the verifier are invalidated and must be
16161616 * performed again, if the helper is used in combination with
@@ -1852,7 +1852,7 @@ union bpf_attr { · 235 unmodified lines
18521852 * copied if necessary (i.e. if data was not linear and if start
18531853 * and end pointers do not point to the same chunk).
18541854 *
1855− * A call to this helper is susceptible to change the underlaying
1855+ * A call to this helper is susceptible to change the underlying
18561856 * packet buffer. Therefore, at load time, all checks on pointers
18571857 * previously done by the verifier are invalidated and must be
18581858 * performed again, if the helper is used in combination with
@@ -1886,7 +1886,7 @@ union bpf_attr { · 27 unmodified lines
18861886 * only possible to shrink the packet as of this writing,
18871887 * therefore *delta* must be a negative integer.
18881888 *
1889− * A call to this helper is susceptible to change the underlaying
1889+ * A call to this helper is susceptible to change the underlying
18901890 * packet buffer. Therefore, at load time, all checks on pointers
18911891 * previously done by the verifier are invalidated and must be
18921892 * performed again, if the helper is used in combination with
@@ -2072,7 +2072,7 @@ union bpf_attr { · 179 unmodified lines
20722072 * by bpf programs of types BPF_PROG_TYPE_LWT_IN and
20732073 * BPF_PROG_TYPE_LWT_XMIT.
20742074 *
2075− * A call to this helper is susceptible to change the underlaying
2075+ * A call to this helper is susceptible to change the underlying
20762076 * packet buffer. Therefore, at load time, all checks on pointers
20772077 * previously done by the verifier are invalidated and must be
20782078 * performed again, if the helper is used in combination with
@@ -2087,7 +2087,7 @@ union bpf_attr { · 8 unmodified lines
20872087 * inside the outermost IPv6 Segment Routing Header can be
20882088 * modified through this helper.
20892089 *
2090− * A call to this helper is susceptible to change the underlaying
2090+ * A call to this helper is susceptible to change the underlying
20912091 * packet buffer. Therefore, at load time, all checks on pointers
20922092 * previously done by the verifier are invalidated and must be
20932093 * performed again, if the helper is used in combination with
@@ -2103,7 +2103,7 @@ union bpf_attr { · 9 unmodified lines
21032103 * after the segments are accepted. *delta* can be as well
21042104 * positive (growing) as negative (shrinking).
21052105 *
2106− * A call to this helper is susceptible to change the underlaying
2106+ * A call to this helper is susceptible to change the underlying
21072107 * packet buffer. Therefore, at load time, all checks on pointers
21082108 * previously done by the verifier are invalidated and must be
21092109 * performed again, if the helper is used in combination with
@@ -2132,7 +2132,7 @@ union bpf_attr { · 22 unmodified lines
21322132 * encapsulation policy.
21332133 * Type of param: **struct ipv6_sr_hdr**.
21342134 *
2135− * A call to this helper is susceptible to change the underlaying
2135+ * A call to this helper is susceptible to change the underlying
21362136 * packet buffer. Therefore, at load time, all checks on pointers
21372137 * previously done by the verifier are invalidated and must be
21382138 * performed again, if the helper is used in combination with