• Ingo Molnar's avatar
    x86/bpf: Clean up non-standard comments, to make the code more readable · a2c7a983
    Ingo Molnar authored
    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.
    
    ( In case this commit causes conflicts with pending development code
      I'll be glad to help resolve any conflicts! )
    Acked-by: default avatarThomas 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: default avatarIngo Molnar <mingo@kernel.org>
    Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
    a2c7a983
bpf_jit_comp.c 33.3 KB