Skip to content
  • Jeff King's avatar
    docs: put listed example commands in backticks · 5d2fc913
    Jeff King authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    Many examples of git command invocation are given in asciidoc listing
    blocks, which makes them monospaced and avoids further interpretation of
    special characters.  Some manpages make a list of examples, like:
    
      git foo::
        Run git foo.
    
      git foo -q::
        Use the "-q" option.
    
    to quickly show many variants. However, they can sometimes be hard to
    read, because they are shown in a proportional-width font (so, for
    example, seeing the difference between "-- foo" and "--foo" can be
    difficult).
    
    This patch puts all such examples into backticks, which gives the
    equivalent formatting to a listing block (i.e., monospaced and without
    character interpretation).
    
    As a bonus, this also fixes an example in the git-push manpage, in which
    "git push origin :::" was accidentally considered a newly-indented list,
    and not a list item with "git push origin :" in it.
    
    Signed-off-by: default avatarJeff King <peff@peff.net>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    5d2fc913