Linux-man Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] bpf: Fix reStructuredText markup
@ 2020-04-20 14:47 Jakub Wilk
  2020-04-22  8:23 ` [PATCH v2] " Jakub Wilk
  2020-04-25  0:09 ` [PATCH] " Alexei Starovoitov
  0 siblings, 2 replies; 4+ messages in thread
From: Jakub Wilk @ 2020-04-20 14:47 UTC (permalink / raw)
  To: bpf, Alexei Starovoitov, Daniel Borkmann; +Cc: linux-man, Michael Kerrisk

Fixes:

    $ scripts/bpf_helpers_doc.py > bpf-helpers.rst
    $ rst2man bpf-helpers.rst > bpf-helpers.7
    bpf-helpers.rst:1105: (WARNING/2) Inline strong start-string without end-string.

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
---
 include/uapi/linux/bpf.h       | 2 +-
 tools/include/uapi/linux/bpf.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 2e29a671d67e..c879c155bf3b 100644
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -1642,7 +1642,7 @@ union bpf_attr {
  * 		ifindex, but doesn't require a map to do so.
  * 	Return
  * 		**XDP_REDIRECT** on success, or the value of the two lower bits
- * 		of the **flags* argument on error.
+ * 		of the **flags** argument on error.
  *
  * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
  * 	Description
diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h
index 2e29a671d67e..c879c155bf3b 100644
--- a/tools/include/uapi/linux/bpf.h
+++ b/tools/include/uapi/linux/bpf.h
@@ -1642,7 +1642,7 @@ union bpf_attr {
  * 		ifindex, but doesn't require a map to do so.
  * 	Return
  * 		**XDP_REDIRECT** on success, or the value of the two lower bits
- * 		of the **flags* argument on error.
+ * 		of the **flags** argument on error.
  *
  * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
  * 	Description
-- 
2.26.1


^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH v2] bpf: Fix reStructuredText markup
  2020-04-20 14:47 [PATCH] bpf: Fix reStructuredText markup Jakub Wilk
@ 2020-04-22  8:23 ` Jakub Wilk
  2020-04-23  9:07   ` Quentin Monnet
  2020-04-25  0:09 ` [PATCH] " Alexei Starovoitov
  1 sibling, 1 reply; 4+ messages in thread
From: Jakub Wilk @ 2020-04-22  8:23 UTC (permalink / raw)
  To: bpf, Alexei Starovoitov, Daniel Borkmann; +Cc: linux-man, Michael Kerrisk

Fixes:

    $ scripts/bpf_helpers_doc.py > bpf-helpers.rst
    $ rst2man bpf-helpers.rst > bpf-helpers.7
    bpf-helpers.rst:1105: (WARNING/2) Inline strong start-string without end-string.

Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
---
v2: "flags" should be italic, not bold

 include/uapi/linux/bpf.h       | 2 +-
 tools/include/uapi/linux/bpf.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 2e29a671d67e..7bbf1b65be10 100644
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -1642,7 +1642,7 @@ union bpf_attr {
  * 		ifindex, but doesn't require a map to do so.
  * 	Return
  * 		**XDP_REDIRECT** on success, or the value of the two lower bits
- * 		of the **flags* argument on error.
+ * 		of the *flags* argument on error.
  *
  * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
  * 	Description
diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h
index 2e29a671d67e..7bbf1b65be10 100644
--- a/tools/include/uapi/linux/bpf.h
+++ b/tools/include/uapi/linux/bpf.h
@@ -1642,7 +1642,7 @@ union bpf_attr {
  * 		ifindex, but doesn't require a map to do so.
  * 	Return
  * 		**XDP_REDIRECT** on success, or the value of the two lower bits
- * 		of the **flags* argument on error.
+ * 		of the *flags* argument on error.
  *
  * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
  * 	Description
-- 
2.26.2


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2] bpf: Fix reStructuredText markup
  2020-04-22  8:23 ` [PATCH v2] " Jakub Wilk
@ 2020-04-23  9:07   ` Quentin Monnet
  0 siblings, 0 replies; 4+ messages in thread
From: Quentin Monnet @ 2020-04-23  9:07 UTC (permalink / raw)
  To: Jakub Wilk, bpf, Alexei Starovoitov, Daniel Borkmann
  Cc: linux-man, Michael Kerrisk

2020-04-22 10:23 UTC+0200 ~ Jakub Wilk <jwilk@jwilk.net>
> Fixes:
> 
>     $ scripts/bpf_helpers_doc.py > bpf-helpers.rst
>     $ rst2man bpf-helpers.rst > bpf-helpers.7
>     bpf-helpers.rst:1105: (WARNING/2) Inline strong start-string without end-string.
> 
> Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
> ---
> v2: "flags" should be italic, not bold
> 
>  include/uapi/linux/bpf.h       | 2 +-
>  tools/include/uapi/linux/bpf.h | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
> index 2e29a671d67e..7bbf1b65be10 100644
> --- a/include/uapi/linux/bpf.h
> +++ b/include/uapi/linux/bpf.h
> @@ -1642,7 +1642,7 @@ union bpf_attr {
>   * 		ifindex, but doesn't require a map to do so.
>   * 	Return
>   * 		**XDP_REDIRECT** on success, or the value of the two lower bits
> - * 		of the **flags* argument on error.
> + * 		of the *flags* argument on error.
>   *
>   * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
>   * 	Description
> diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h
> index 2e29a671d67e..7bbf1b65be10 100644
> --- a/tools/include/uapi/linux/bpf.h
> +++ b/tools/include/uapi/linux/bpf.h
> @@ -1642,7 +1642,7 @@ union bpf_attr {
>   * 		ifindex, but doesn't require a map to do so.
>   * 	Return
>   * 		**XDP_REDIRECT** on success, or the value of the two lower bits
> - * 		of the **flags* argument on error.
> + * 		of the *flags* argument on error.
>   *
>   * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
>   * 	Description
> 

I was about to send the same :). Thanks!

Reviewed-by: Quentin Monnet <quentin@isovalent.com>

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] bpf: Fix reStructuredText markup
  2020-04-20 14:47 [PATCH] bpf: Fix reStructuredText markup Jakub Wilk
  2020-04-22  8:23 ` [PATCH v2] " Jakub Wilk
@ 2020-04-25  0:09 ` Alexei Starovoitov
  1 sibling, 0 replies; 4+ messages in thread
From: Alexei Starovoitov @ 2020-04-25  0:09 UTC (permalink / raw)
  To: Jakub Wilk
  Cc: bpf, Alexei Starovoitov, Daniel Borkmann, linux-man, Michael Kerrisk

On Mon, Apr 20, 2020 at 7:56 AM Jakub Wilk <jwilk@jwilk.net> wrote:
>
> Fixes:
>
>     $ scripts/bpf_helpers_doc.py > bpf-helpers.rst
>     $ rst2man bpf-helpers.rst > bpf-helpers.7
>     bpf-helpers.rst:1105: (WARNING/2) Inline strong start-string without end-string.
>
> Signed-off-by: Jakub Wilk <jwilk@jwilk.net>

I think that's bpf tree material. Applied

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, back to index

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-20 14:47 [PATCH] bpf: Fix reStructuredText markup Jakub Wilk
2020-04-22  8:23 ` [PATCH v2] " Jakub Wilk
2020-04-23  9:07   ` Quentin Monnet
2020-04-25  0:09 ` [PATCH] " Alexei Starovoitov

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git