• Mark Rutland's avatar
    locking/atomic: scripts: generate kerneldoc comments · ad811070
    Mark Rutland authored
    Currently the atomics are documented in Documentation/atomic_t.txt, and
    have no kerneldoc comments. There are a sufficient number of gotchas
    (e.g. semantics, noinstr-safety) that it would be nice to have comments
    to call these out, and it would be nice to have kerneldoc comments such
    that these can be collated.
    
    While it's possible to derive the semantics from the code, this can be
    painful given the amount of indirection we currently have (e.g. fallback
    paths), and it's easy to be mislead by naming, e.g.
    
    * The unconditional void-returning ops *only* have relaxed variants
      without a _relaxed suffix, and can easily be mistaken for being fully
      ordered.
    
      It would be nice to give these a _relaxed() suffix, but this would
      result in significant churn throughout the kernel.
    
    * Our naming of conditional and unconditional+test ops is rather
      inconsistent, and it can be difficult to derive the name of an
      operation, or to identify where an op is conditio...
    ad811070
atomic-tbl.sh 5.6 KB