| blob | 72beaec20d9f83cd771c610f0b08e2694be65860 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-rev-parse(1) Manual Page
407 </h1>
410 <p>git-rev-parse -
411 Pick out and massage parameters
412 </p>
413 </div>
414 </div>
418 </div>
424 and flags and parameters for the other commands they use
426 distinguish between them.</p></div>
427 </div>
432 --parseopt
433 </dt>
434 <dd>
435 <p>
437 </p>
438 </dd>
440 --keep-dashdash
441 </dt>
442 <dd>
443 <p>
446 </p>
447 </dd>
449 --stop-at-non-option
450 </dt>
451 <dd>
452 <p>
454 the first non-option argument. This can be used to parse sub-commands
455 that take options themselves.
456 </p>
457 </dd>
459 --sq-quote
460 </dt>
461 <dd>
462 <p>
465 mode does only quoting. Nothing else is done to command input.
466 </p>
467 </dd>
469 --revs-only
470 </dt>
471 <dd>
472 <p>
473 Do not output flags and parameters not meant for
475 </p>
476 </dd>
478 --no-revs
479 </dt>
480 <dd>
481 <p>
482 Do not output flags and parameters meant for
484 </p>
485 </dd>
487 --flags
488 </dt>
489 <dd>
490 <p>
491 Do not output non-flag parameters.
492 </p>
493 </dd>
495 --no-flags
496 </dt>
497 <dd>
498 <p>
499 Do not output flag parameters.
500 </p>
501 </dd>
504 </dt>
505 <dd>
506 <p>
508 instead.
509 </p>
510 </dd>
512 --verify
513 </dt>
514 <dd>
515 <p>
516 The parameter given must be usable as a single, valid
517 object name. Otherwise barf and abort.
518 </p>
519 </dd>
521 -q
522 </dt>
524 --quiet
525 </dt>
526 <dd>
527 <p>
529 message if the first argument is not a valid object name;
530 instead exit with non-zero status silently.
531 </p>
532 </dd>
534 --sq
535 </dt>
536 <dd>
537 <p>
538 Usually the output is made one line per flag and
539 parameter. This option makes output a single line,
540 properly quoted for consumption by shell. Useful when
541 you expect your parameter to contain whitespaces and
544 the command input is still interpreted as usual.
545 </p>
546 </dd>
548 --not
549 </dt>
550 <dd>
551 <p>
554 one.
555 </p>
556 </dd>
558 --symbolic
559 </dt>
560 <dd>
561 <p>
562 Usually the object names are output in SHA1 form (with
564 form as close to the original input as possible.
565 </p>
566 </dd>
568 --symbolic-full-name
569 </dt>
570 <dd>
571 <p>
572 This is similar to --symbolic, but it omits input that
573 are not refs (i.e. branch or tag names; or more
574 explicitly disambiguating "heads/master" form, when you
575 want to name the "master" branch when there is an
576 unfortunately named tag "master"), and show them as full
577 refnames (e.g. "refs/heads/master").
578 </p>
579 </dd>
581 --abbrev-ref[=(strict|loose)]
582 </dt>
583 <dd>
584 <p>
585 A non-ambiguous short name of the objects name.
586 The option core.warnAmbiguousRefs is used to select the strict
587 abbreviation mode.
588 </p>
589 </dd>
591 --all
592 </dt>
593 <dd>
594 <p>
596 </p>
597 </dd>
599 --branches[=pattern]
600 </dt>
602 --tags[=pattern]
603 </dt>
605 --remotes[=pattern]
606 </dt>
607 <dd>
608 <p>
609 Show all branches, tags, or remote-tracking branches,
612 </p>
613 <div class="paragraph"><p>If a <tt>pattern</tt> is given, only refs matching the given shell glob are
617 </dd>
619 --glob=pattern
620 </dt>
621 <dd>
622 <p>
625 prepended. If the pattern does not contain a globbing
628 </p>
629 </dd>
631 --show-toplevel
632 </dt>
633 <dd>
634 <p>
635 Show the absolute path of the top-level directory.
636 </p>
637 </dd>
639 --show-prefix
640 </dt>
641 <dd>
642 <p>
643 When the command is invoked from a subdirectory, show the
644 path of the current directory relative to the top-level
645 directory.
646 </p>
647 </dd>
649 --show-cdup
650 </dt>
651 <dd>
652 <p>
653 When the command is invoked from a subdirectory, show the
654 path of the top-level directory relative to the current
655 directory (typically a sequence of "../", or an empty string).
656 </p>
657 </dd>
659 --git-dir
660 </dt>
661 <dd>
662 <p>
664 the .git directory, relative to the current directory.
665 </p>
667 is not detected to lie in a git repository or work tree
668 print a message to stderr and exit with nonzero status.</p></div>
669 </dd>
671 --is-inside-git-dir
672 </dt>
673 <dd>
674 <p>
675 When the current working directory is below the repository
677 </p>
678 </dd>
680 --is-inside-work-tree
681 </dt>
682 <dd>
683 <p>
684 When the current working directory is inside the work tree of the
686 </p>
687 </dd>
689 --is-bare-repository
690 </dt>
691 <dd>
692 <p>
694 </p>
695 </dd>
697 --local-env-vars
698 </dt>
699 <dd>
700 <p>
701 List the GIT_* environment variables that are local to the
702 repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
703 Only the names of the variables are listed, not their value,
704 even if they are set.
705 </p>
706 </dd>
708 --short
709 </dt>
711 --short=number
712 </dt>
713 <dd>
714 <p>
715 Instead of outputting the full SHA1 values of object names try to
716 abbreviate them to a shorter unique name. When no length is specified
718 </p>
719 </dd>
721 --since=datestring
722 </dt>
724 --after=datestring
725 </dt>
726 <dd>
727 <p>
728 Parse the date string, and output the corresponding
730 </p>
731 </dd>
733 --until=datestring
734 </dt>
736 --before=datestring
737 </dt>
738 <dd>
739 <p>
740 Parse the date string, and output the corresponding
742 </p>
743 </dd>
746 </dt>
747 <dd>
748 <p>
749 Flags and parameters to be parsed.
750 </p>
751 </dd>
752 </dl></div>
753 </div>
758 syntax. Here are various ways to spell object names. The
759 ones listed near the end of this list are to name trees and
760 blobs contained in a commit.</p></div>
762 <li>
763 <p>
764 The full SHA1 object name (40-byte hexadecimal string), or
765 a substring of such that is unique within the repository.
766 E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
767 name the same commit object if there are no other object in
768 your repository whose object name starts with dae86e.
769 </p>
770 </li>
771 <li>
772 <p>
774 followed by a dash and a number of commits, followed by a dash, a
776 </p>
777 </li>
778 <li>
779 <p>
781 object referenced by refs/heads/master. If you
782 happen to have both heads/master and tags/master, you can
785 first match in the following rules:
786 </p>
788 <li>
789 <p>
793 </p>
794 </li>
795 <li>
796 <p>
798 </p>
799 </li>
800 <li>
801 <p>
803 </p>
804 </li>
805 <li>
806 <p>
808 </p>
809 </li>
810 <li>
811 <p>
813 </p>
814 </li>
815 <li>
816 <p>
818 </p>
820 FETCH_HEAD records the branch you fetched from a remote repository
822 ORIG_HEAD is created by commands that moves your HEAD in a drastic
823 way, to record the position of the HEAD before their operation, so that
824 you can change the tip of the branch back to the state before you ran
825 them easily.
826 MERGE_HEAD records the commit(s) you are merging into your branch
828 CHERRY_PICK_HEAD records the commit you are cherry-picking
832 </li>
833 </ol></div>
834 </li>
835 <li>
836 <p>
838 enclosed in a brace
841 of the ref at a prior point in time. This suffix may only be
842 used immediately following a ref name and the ref must have an
847 </p>
848 </li>
849 <li>
850 <p>
856 immediately following a ref name and the ref must have an existing
858 </p>
859 </li>
860 <li>
861 <p>
863 reflog of the current branch. For example, if you are on the
865 </p>
866 </li>
867 <li>
868 <p>
870 before the current one.
871 </p>
872 </li>
873 <li>
874 <p>
876 the branch the ref is set to build on top of. Missing ref defaults
877 to the current branch.
878 </p>
879 </li>
880 <li>
881 <p>
882 A suffix <em>^</em> to a revision parameter (e.g. <em>HEAD^</em>) means the first parent of
887 object name of a tag object that refers to a commit object.
888 </p>
889 </li>
890 <li>
891 <p>
894 commit object, following only the first parent. I.e. rev~3 is
895 equivalent to rev^^^ which is equivalent to
897 the usage of this form.
898 </p>
899 </li>
900 <li>
901 <p>
904 could be a tag, and dereference the tag recursively until an
905 object of that type is found or the object cannot be
908 </p>
909 </li>
910 <li>
911 <p>
914 and dereference the tag recursively until a non-tag object is
915 found.
916 </p>
917 </li>
918 <li>
919 <p>
923 it returns the youngest matching commit which is reachable from
925 </p>
926 </li>
927 <li>
928 <p>
930 a commit whose commit message matches the specified regular expression.
931 This name returns the youngest matching commit which is
932 reachable from any ref. If the commit message starts with a
935 The regular expression can match any part of the commit message. To
937 </p>
938 </li>
939 <li>
940 <p>
942 at the given path in the tree-ish object named by the part
943 before the colon.
945 is a special case of the syntax described next: content
946 recorded in the index at the given path.
948 The given path will be converted to be relative to working tree’s root directory.
949 This is most useful to address a blob or tree from a commit or tree that has
950 the same tree structure with the working tree.
951 </p>
952 </li>
953 <li>
954 <p>
957 index at the given path. Missing stage number (and the colon
960 (typically the current branch), and stage 3 is the version from
961 the branch being merged.
962 </p>
963 </li>
964 </ul></div>
966 and C are parents of commit node A. Parent commits are ordered
967 left-to-right.</p></div>
970 <pre><tt>G H I J
971 \ / \ /
972 D E F
973 \ | / \
974 \ | / |
975 \|/ |
976 B C
977 \ /
978 \ /
979 A</tt></pre>
980 </div></div>
993 </div></div>
994 </div>
998 of commits, not just a single commit. To these commands,
999 specifying a single revision with the notation described in the
1000 previous section means the set of commits reachable from that
1001 commit, following the commit ancestry chain.</p></div>
1007 to the syntax explained in SPECIFYING REVISIONS above), you can ask
1008 for commits that are reachable from r2 excluding those that are reachable
1013 It is the set of commits that are reachable from either one of
1018 all of its parents.</p></div>
1022 <pre><tt>D G H D
1023 D F G H I J D F
1024 ^G D H D
1025 ^D B E I J F B
1026 B...C G H D E B C
1027 ^D B C E I J F B C
1028 C^@ I J F
1029 F^! D G H D F</tt></pre>
1030 </div></div>
1031 </div>
1034 <div class="paragraph"><p>In <tt>--parseopt</tt> mode, <em>git rev-parse</em> helps massaging options to bring to shell
1035 scripts the same facilities C builtins have. It works as an option normalizer
1037 <div class="paragraph"><p>It takes on the standard input the specification of the options to parse and
1038 understand, and echoes on the standard output a string suitable for <tt>sh(1)</tt> <tt>eval</tt>
1039 to replace the arguments with normalized ones. In case of error, it outputs
1041 <div class="paragraph"><p>Note: Make sure you quote the result when passing it to <tt>eval</tt>. See
1042 below for an example.</p></div>
1044 <div class="paragraph"><p><em>git rev-parse --parseopt</em> input format is fully text based. It has two parts,
1046 (should be more than one) are used for the usage.
1047 The lines after the separator describe the options.</p></div>
1052 </div></div>
1056 </dt>
1057 <dd>
1058 <p>
1059 its format is the short option character, then the long option name
1060 separated by a comma. Both parts are not required, though at least one
1063 </p>
1064 </dd>
1067 </dt>
1068 <dd>
1069 <p>
1071 </p>
1073 <li>
1074 <p>
1076 </p>
1077 </li>
1078 <li>
1079 <p>
1081 </p>
1082 </li>
1083 <li>
1084 <p>
1088 </p>
1089 </li>
1090 <li>
1091 <p>
1093 </p>
1094 </li>
1095 </ul></div>
1096 </dd>
1097 </dl></div>
1099 as the help associated to the option.</p></div>
1100 <div class="paragraph"><p>Blank lines are ignored, and lines that don’t match this specification are used
1101 as option group headers (start the line with a space to create such
1102 lines on purpose).</p></div>
1107 some-command [options] <args>...
1109 some-command does foo and bar!
1110 --
1111 h,help show the help
1113 foo some nifty option --foo
1114 bar= some cool option --bar with an argument
1116 An option group Header
1117 C? option C with an optional argument"
1120 </div></div>
1121 </div>
1124 <div class="paragraph"><p>In <tt>--sq-quote</tt> mode, <em>git rev-parse</em> echoes on the standard output a
1127 quoting the arguments is done.</p></div>
1130 option.</p></div>
1135 #!/bin/sh
1136 args=$(git rev-parse --sq-quote "$@") # quote user-supplied arguments
1138 # command line
1139 eval "$command"
1140 EOF
1143 </div></div>
1144 </div>
1148 <li>
1149 <p>
1150 Print the object name of the current commit:
1151 </p>
1155 </div></div>
1156 </li>
1157 <li>
1158 <p>
1159 Print the commit object name from the revision in the $REV shell variable:
1160 </p>
1164 </div></div>
1165 <div class="paragraph"><p>This will error out if $REV is empty or not a valid revision.</p></div>
1166 </li>
1167 <li>
1168 <p>
1169 Same as above:
1170 </p>
1174 </div></div>
1175 <div class="paragraph"><p>but if $REV is empty, the commit object name from master will be printed.</p></div>
1176 </li>
1177 </ul></div>
1178 </div>
1182 </div>
1186 </div>
1187 </div>
1188 </body>
1189 </html>