Skip to content
  • Matthieu Moy's avatar
    Documentation: explain optional arguments better · 2b594bf9
    Matthieu Moy authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    Improve the documentation of commands taking optional arguments in two
    ways:
    
    * Documents the behavior of '-O' (for grep) and '-S' (for commands
      creating commits) when used without the optional argument.
    
    * Document the syntax of these options.
    
    For the second point, the behavior is documented in gitcli(7), but it is
    easy for users to miss, and hard for the same user to understand why e.g.
    "git status -u no" does not work.
    
    Document this explicitly in the documentation of each short option having
    an optional argument: they are the most error prone since there is no '='
    sign between the option and its argument.
    
    Signed-off-by: default avatarMatthieu Moy <Matthieu.Moy@imag.fr>
    Reviewed-by: default avatarJeff King <peff@peff.net>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    2b594bf9