Skip to content
  • Kaartic Sivaraam's avatar
    Doc/check-ref-format: clarify information about @{-N} syntax · c6342e05
    Kaartic Sivaraam authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    When the N-th previous thing checked out syntax (@{-N}) is used
    with '--branch' option of check-ref-format the result may not be
    the name of a branch that currently exists or ever existed. This
    is because @{-N} is used to refer to the N-th last checked out
    "thing", which might be a commit object name if the previous check
    out was a detached HEAD state; or a branch name, otherwise. The
    documentation thus does a wrong thing by promoting it as the
    "previous branch syntax".
    
    State that @{-N} is the syntax for specifying "N-th last thing
    checked out" and also state that the result of using @{-N} might
    also result in an commit object name.
    
    Signed-off-by: default avatarKaartic Sivaraam <kaartic.sivaraam@gmail.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    c6342e05