• Ingo Molnar's avatar
    tick/nohz: Update comments some more · 6c774377
    Ingo Molnar authored
    Inspired by recent enhancements to comments in kernel/time/tick-sched.c,
    go through the entire file and fix/unify its comments:
    
     - Fix over a dozen typos, spelling mistakes & cases of bad grammar.
    
     - Re-phrase sentences that I needed to read three times to understand.
    
        [ I used the following arbitrary rule-of-thumb:
           - if I had to read a comment twice, it was usually my fault,
           - if I had to read it a third time, it was the comment's fault. ]
    
     - Comma updates:
    
        - Add commas where needed
    
        - Remove commas where not needed
    
        - In cases where a comma is optional, choose one variant and try to
          standardize it over similar sentences in the file.
    
     - Standardize on standalone 'NOHZ' spelling in free-flowing comments:
    
          s/nohz/NOHZ
          s/no idle tick/NOHZ
    
       Still keep 'dynticks' as a popular synonym.
    
     - Standardize on referring to variable names within free-flowing
       comments with the "'var'" nomenclature, and function names as
       "function_name()".
    
     - Standardize on '64-bit' and '32-bit':
         s/32bit/32-bit
         s/64bit/64-bit
    
     - Standardize on 'IRQ work':
         s/irq work/IRQ work
    
     - A few other tidyups I probably missed to list.
    
    No change in functionality intended - other than one small change to
    a syslog output string.
    Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
    Acked-by: default avatarFrederic Weisbecker <frederic@kernel.org>
    Link: https://lore.kernel.org/r/ZRVCNeMcSQcXS36N@gmail.com
    6c774377
tick-sched.c 41.4 KB