Elektra 0.11.0
keyCmp

Signature

int keyCmp(const Key *k1, const Key *k2)

Checklist

Doxygen

(bullet points are in order of appearance)

  • First line explains briefly what the function does
  • Simple example or snippet how to use the function
    • move last example below brief explanation
  • Longer description of function containing common use cases
    • add description about behavior of namespace comparison
  • Description of functions reads nicely
  • @pre
    • add
  • @post
    • add
  • @invariant
    • add
  • @param for every parameter
  • @return / @retval
    • remove @return in favor of @retval's?
    • add @retval for k1 > k2
    • add @retval for k1 == k2
    • add @retval for k1 < k2
  • @since
    • add
  • @ingroup
  • @see

Naming

  • Abbreviations used in function names must be defined in the Glossary
    • Define Cmp or write it out?
  • Function names should neither be too long, nor too short
  • Function name should be clear and unambiguous
  • Abbreviations used in parameter names must be defined in the Glossary
  • Parameter names should neither be too long, nor too short
    • k1 -> key1 / this - [ ] k2 -> key2 / that
  • Parameter names should be clear and unambiguous

Compatibility

(only in PRs)

  • Symbol versioning is correct for breaking changes
  • ABI/API changes are forward-compatible (breaking backwards-compatibility to add additional symbols is fine)

Parameter & Return Types

  • Function parameters should use enum types instead of boolean types wherever sensible
  • Wherever possible, function parameters should be const
  • Wherever possible, return types should be const
  • Functions should have the least amount of parameters feasible

Structural Clarity

  • Functions should do exactly one thing
  • Function name has the appropriate prefix
  • Order of signatures in kdb.h.in is the same as Doxygen
  • No functions with similar purpose exist

Memory Management

  • Memory Management should be handled by the function wherever possible

Extensibility

  • Function is easily extensible, e.g., with flags
    • add flags for comparing specific parts of the key
  • Documentation does not impose limits, that would hinder further extensions

Tests

  • Function code is fully covered by tests
    • L517
    • L558
  • All possible error states are covered by tests
    • test key with same name, but different owners
  • All possible enum values are covered by tests
  • No inconsistencies between tests and documentation

Summary

move implementation out of keyset.c ?

Other Issues discovered (unrelated to function)