X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-symbolic-ref.txt;h=63925388073b17c3087d32813979513580adfa2a;hb=9e4a90ba19033d25dca1eea495b0a8c5f06efbc6;hp=5709dee20835e1b8c2f7832632f5f6184be2984b;hpb=438d2991eaa17549df67929cd4558d65840c37d7;p=git.git diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt index 5709dee20..639253880 100644 --- a/Documentation/git-symbolic-ref.txt +++ b/Documentation/git-symbolic-ref.txt @@ -7,16 +7,16 @@ git-symbolic-ref - Read and modify symbolic refs SYNOPSIS -------- -'git-symbolic-ref' [-q] [-m ] [] +'git symbolic-ref' [-q] [-m ] [] DESCRIPTION ----------- Given one argument, reads which branch head the given symbolic ref refers to and outputs its path, relative to the `.git/` directory. Typically you would give `HEAD` as the -argument to see on which branch your working tree is on. +argument to see which branch your working tree is on. -Give two arguments, create or update a symbolic ref to +Given two arguments, creates or updates a symbolic ref to point at the given branch . A symbolic ref is a regular file that stores a string that @@ -49,7 +49,7 @@ cumbersome. On some platforms, `ln -sf` does not even work as advertised (horrors). Therefore symbolic links are now deprecated and symbolic refs are used by default. -git-symbolic-ref will exit with status 0 if the contents of the +'git-symbolic-ref' will exit with status 0 if the contents of the symbolic ref were printed correctly, with status 1 if the requested name is not a symbolic ref, or 128 if another error occurs.