History

bpf: Fix a few typos in BPF helpers documentation

Address a few typos in the documentation for the BPF helper functions. They were reported by Jakub [0], who ran spell checkers on the generated man page [1]. [0] https://lore.kernel.org/linux-man/d22dcd47-023c-8f52-d369-7b5308e6c842@gmail.com/T/#mb02e7d4b7fb61d98fa914c77b581184e9a9537af [1] https://lore.kernel.org/linux-man/eb6a1e41-c48e-ac45-5154-ac57a2c76108@gmail.com/T/#m4a8d1b003616928013ffcd1450437309ab652f9f v3: Do not copy unrelated (and breaking) elements to tools/ header v2: Turn a ',' into a ';'

Quentin Monnet committed 4 years ago

Commit aa756221 parent b05d64e2 files · +16 −16Browse files

Showing the changes to tools/include/uapi/linux (1 of 2 files). Show all

Unified · Split

tools/include/uapi/linux/bpf.h+8−8
@@ -4456,7 +4456,7 @@ union bpf_attr { · 4455 unmodified lines
44564456 *
44574457 * **-EEXIST** if the option already exists.
44584458 *
4459− * **-EFAULT** on failrue to parse the existing header options.
4459+ * **-EFAULT** on failure to parse the existing header options.
44604460 *
44614461 * **-EPERM** if the helper cannot be used under the current
44624462 * *skops*\ **->op**.
@@ -4665,7 +4665,7 @@ union bpf_attr { · 202 unmodified lines
46654665 * a *map* with *task* as the **key**. From this
46664666 * perspective, the usage is not much different from
46674667 * **bpf_map_lookup_elem**\ (*map*, **&**\ *task*) except this
4668− * helper enforces the key must be an task_struct and the map must also
4668+ * helper enforces the key must be a task_struct and the map must also
46694669 * be a **BPF_MAP_TYPE_TASK_STORAGE**.
46704670 *
46714671 * Underneath, the value is stored locally at *task* instead of
@@ -4723,7 +4723,7 @@ union bpf_attr { · 51 unmodified lines
47234723 *
47244724 * long bpf_ima_inode_hash(struct inode *inode, void *dst, u32 size)
47254725 * Description
4726− * Returns the stored IMA hash of the *inode* (if it's avaialable).
4726+ * Returns the stored IMA hash of the *inode* (if it's available).
47274727 * If the hash is larger than *size*, then only *size*
47284728 * bytes will be copied to *dst*
47294729 * Return
@@ -4747,12 +4747,12 @@ union bpf_attr { · 17 unmodified lines
47474747 *
47484748 * The argument *len_diff* can be used for querying with a planned
47494749 * size change. This allows to check MTU prior to changing packet
4750− * ctx. Providing an *len_diff* adjustment that is larger than the
4750+ * ctx. Providing a *len_diff* adjustment that is larger than the
47514751 * actual packet size (resulting in negative packet size) will in
4752− * principle not exceed the MTU, why it is not considered a
4753− * failure. Other BPF-helpers are needed for performing the
4754− * planned size change, why the responsability for catch a negative
4755− * packet size belong in those helpers.
4752+ * principle not exceed the MTU, which is why it is not considered
4753+ * a failure. Other BPF helpers are needed for performing the
4754+ * planned size change; therefore the responsibility for catching
4755+ * a negative packet size belongs in those helpers.
47564756 *
47574757 * Specifying *ifindex* zero means the MTU check is performed
47584758 * against the current net device. This is practical if this isn't

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t