Skip to content
  • Jeff King's avatar
    assert NOARG/NONEG behavior of parse-options callbacks · 517fe807
    Jeff King authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    When we define a parse-options callback, the flags we put in the option
    struct must match what the callback expects. For example, a callback
    which does not handle the "unset" parameter should only be used with
    PARSE_OPT_NONEG. But since the callback and the option struct are not
    defined next to each other, it's easy to get this wrong (as earlier
    patches in this series show).
    
    Fortunately, the compiler can help us here: compiling with
    -Wunused-parameters can show us which callbacks ignore their "unset"
    parameters (and likewise, ones that ignore "arg" expect to be triggered
    with PARSE_OPT_NOARG).
    
    But after we've inspected a callback and determined that all of its
    callers use the right flags, what do we do next? We'd like to silence
    the compiler warning, but do so in a way that will catch any wrong calls
    in the future.
    
    We can do that by actually checking those variables and asserting that
    they match our expectations. Because this is such a common pattern,
    we'll introduce some helper macros. The resulting messages aren't
    as descriptive as we could make them, but the file/line information from
    BUG() is enough to identify the problem (and anyway, the point is that
    these should never be seen).
    
    Each of the annotated callbacks in this patch triggers
    -Wunused-parameters, and was manually inspected to make sure all callers
    use the correct options (so none of these BUGs should be triggerable).
    
    Signed-off-by: default avatarJeff King <peff@peff.net>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    517fe807