LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Daniel Borkmann <daniel@iogearbox.net>
To: peterz@infradead.org, edumazet@google.com, davem@davemloft.net,
	linux-kernel@vger.kernel.org, torvalds@linux-foundation.org,
	ast@fb.com, bp@alien8.de, hpa@zytor.com, mingo@kernel.org,
	yoshfuji@linux-ipv6.org, tglx@linutronix.de,
	linux-tip-commits@vger.kernel.org, netdev@vger.kernel.org
Subject: Re: [tip:x86/cleanups] x86/bpf: Clean up non-standard comments, to make the code more readable
Date: Fri, 27 Apr 2018 14:13:38 +0200	[thread overview]
Message-ID: <44202670-ed43-366b-caf2-f72863ee7c6a@iogearbox.net> (raw)
In-Reply-To: <tip-5f26c50143f58f256535bee8d93a105f36d4d2da@git.kernel.org>

Hi Ingo,

On 04/27/2018 01:00 PM, tip-bot for Ingo Molnar wrote:
> Commit-ID:  5f26c50143f58f256535bee8d93a105f36d4d2da
> Gitweb:     https://git.kernel.org/tip/5f26c50143f58f256535bee8d93a105f36d4d2da
> Author:     Ingo Molnar <mingo@kernel.org>
> AuthorDate: Fri, 27 Apr 2018 11:54:40 +0200
> Committer:  Ingo Molnar <mingo@kernel.org>
> CommitDate: Fri, 27 Apr 2018 12:42:04 +0200
> 
> x86/bpf: Clean up non-standard comments, to make the code more readable
> 
> So by chance I looked into x86 assembly in arch/x86/net/bpf_jit_comp.c and
> noticed the weird and inconsistent comment style it mistakenly learned from
> the networking code:
> 
>  /* Multi-line comment ...
>   * ... looks like this.
>   */
> 
> Fix this to use the standard comment style specified in Documentation/CodingStyle
> and used in arch/x86/ as well:
> 
>  /*
>   * Multi-line comment ...
>   * ... looks like this.
>   */
> 
> Also, to quote Linus's ... more explicit views about this:
> 
>   http://article.gmane.org/gmane.linux.kernel.cryptoapi/21066
> 
>   > But no, the networking code picked *none* of the above sane formats.
>   > Instead, it picked these two models that are just half-arsed
>   > shit-for-brains:
>   >
>   >  (no)
>   >      /* This is disgusting drug-induced
>   >        * crap, and should die
>   >        */
>   >
>   >   (no-no-no)
>   >       /* This is also very nasty
>   >        * and visually unbalanced */
>   >
>   > Please. The networking code actually has the *worst* possible comment
>   > style. You can literally find that (no-no-no) style, which is just
>   > really horribly disgusting and worse than the otherwise fairly similar
>   > (d) in pretty much every way.
> 
> Also improve the comments and some other details while at it:
> 
>  - Don't mix same-line and previous-line comment style on otherwise
>    identical code patterns within the same function,
> 
>  - capitalize 'BPF' and x86 register names consistently,
> 
>  - capitalize sentences consistently,
> 
>  - instead of 'x64' use 'x86-64': x64 is a Microsoft specific term,
> 
>  - use more consistent punctuation,
> 
>  - use standard coding style in macros as well,
> 
>  - fix typos and a few other minor details.
> 
> Consistent coding style is not optional, at least in arch/x86/.
> 
> No change in functionality.

Thanks for the cleanup, looks fine to me!

> ( In case this commit causes conflicts with pending development code
>   I'll be glad to help resolve any conflicts! )

Any objections if we would simply route this via bpf-next tree, otherwise
this will indeed cause really ugly merge conflicts throughout the JIT with
pending work.

> Acked-by: Thomas Gleixner <tglx@linutronix.de>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Borislav Petkov <bp@alien8.de>
> Cc: H. Peter Anvin <hpa@zytor.com>
> Cc: Linus Torvalds <torvalds@linux-foundation.org>
> Cc: David S. Miller <davem@davemloft.net>
> Cc: Eric Dumazet <edumazet@google.com>
> Cc: Daniel Borkmann <daniel@iogearbox.net>
> Cc: Alexei Starovoitov <ast@fb.com>
> Cc: Hideaki YOSHIFUJI <yoshfuji@linux-ipv6.org>
> Cc: netdev@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Ingo Molnar <mingo@kernel.org>
Acked-by: Daniel Borkmann <daniel@iogearbox.net>

Thanks,
Daniel

       reply	other threads:[~2018-04-27 12:13 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <tip-5f26c50143f58f256535bee8d93a105f36d4d2da@git.kernel.org>
2018-04-27 12:13 ` Daniel Borkmann [this message]
2018-04-27 22:16   ` arch/x86/net/bpf_jit_comp conflicts. was: " Alexei Starovoitov
2018-05-02 14:21     ` Daniel Borkmann

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=44202670-ed43-366b-caf2-f72863ee7c6a@iogearbox.net \
    --to=daniel@iogearbox.net \
    --cc=ast@fb.com \
    --cc=bp@alien8.de \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=hpa@zytor.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=peterz@infradead.org \
    --cc=tglx@linutronix.de \
    --cc=torvalds@linux-foundation.org \
    --cc=yoshfuji@linux-ipv6.org \
    --subject='Re: [tip:x86/cleanups] x86/bpf: Clean up non-standard comments, to make the code more readable' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).