نام (NAME)

git-rev-parse - تجزیه و اعتبارسنجی پارامترها و مشخصات ارجاع

خلاصه دستور (SYNOPSIS)

git rev-parse [<options>] <arg>...

توضیحات (DESCRIPTION)

بسیاری از دستورات سطح بالای (porcelain) گیت ترکیبی از فلگ‌ها (یعنی پارامترهایی که با خط تیره - شروع می‌شوند) و پارامترهای مختص دستور زیربنایی git rev-list که در داخل استفاده می‌کنند، و همچنین فلگ‌ها و پارامترهایی برای سایر دستوراتی که در مراحل بعدی از git rev-list استفاده می‌کنند را دریافت می‌کنند. هدف اصلی این دستور آن است که به برنامه‌های فراخواننده اجازه دهد بین آن‌ها تمایز قائل شوند. چند حالت عملیاتی دیگر نیز وجود دارند که ارتباطی با این موضوع "کمک به تجزیه گزینه‌های خط فرمان" ندارند.

مگر در مواردی که مشخص شده باشد، بیشتر گزینه‌ها و حالت‌های عملیاتی مستلزم اجرای این دستور در داخل یک مخزن گیت یا یک درخت کاری تحت کنترل یک مخزن گیت هستند، و در غیر این صورت یک خطای مهلک (fatal error) نمایش خواهند داد.

گزینه‌ها (OPTIONS)

prefix=$(git rev-parse --show-prefix)
cd "$(git rev-parse --show-toplevel)"
# rev-parse provides the -- needed for 'set'
eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"

مشخص کردن ارجاعات (SPECIFYING REVISIONS)

یک پارامتر بازبینی (revision) به نام <rev> معمولاً، اما نه لزوماً، نام یک شیء کامیت را مشخص می‌کند. این پارامتر از ساختاری موسوم به نحو SHA-1 گسترش‌یافته استفاده می‌کند. در این‌جا روش‌های گوناگونی برای نگارش نام اشیاء آمده است. مواردی که در نزدیکی انتهای این فهرست ذکر شده‌اند، نام درخت‌ها و blobهای موجود در یک کامیت را مشخص می‌کنند.

<sha1>, e.g. dae86e1950b1277e545cee180551750029cfe735, dae86e

<describeOutput>, e.g. v1.7.4.2-679-g3bee7fb

<refname>, e.g. master, heads/master, refs/heads/master

@

[<refname>]@{<date>}, e.g. master@{yesterday}, HEAD@{5 minutes ago}

<refname>@{<n>}, e.g. master@{1}

@{<n>}, e.g. @{1}

@{-<n>}, e.g. @{-1}

[<branchname>]@{upstream}, e.g. master@{upstream}, @{u}

[<branchname>]@{push}, e.g. master@{push}, @{push}

$ git config push.default current
$ git config remote.pushdefault myfork
$ git switch -c mybranch origin/master
$ git rev-parse --symbolic-full-name @{upstream}
refs/remotes/origin/master
$ git rev-parse --symbolic-full-name @{push}
refs/remotes/myfork/mybranch

<rev>^[<n>], e.g. HEAD^, v1.5.1^0

<rev>~[<n>], e.g. HEAD~, master~3

<rev>^{<type>}, e.g. v0.99.8^{commit}

<rev>^{}, e.g. v0.99.8^{}

<rev>^{/<text>}, e.g. HEAD^{/fix nasty bug}

:/<text>, e.g. :/fix nasty bug

<rev>:<path>, e.g. HEAD:README, master:./README

:[<n>:]<path>, e.g. :0:README, :README

در این‌جا تصویری از جان لوئلیگر (Jon Loeliger) آمده است. هر دو گره کامیت B و C والدین گره کامیت A هستند. کامیت‌های والد از چپ به راست مرتب شده‌اند.

G   H   I   J
 \ /     \ /
  D   E   F
   \  |  / \
    \ | /   |
     \|/    |
      B     C
       \   /
        \ /
         A

A =      = A^0
B = A^   = A^1     = A~1
C =      = A^2
D = A^^  = A^1^1   = A~2
E = B^2  = A^^2
F = B^3  = A^^3
G = A^^^ = A^1^1^1 = A~3
H = D^2  = B^^2    = A^^^2  = A~2^2
I = F^   = B^3^    = A^^3^
J = F^2  = B^3^2   = A^^3^2

مشخص کردن محدوده‌ها (SPECIFYING RANGES)

دستورات پیمایش تاریخچه مانند git log بر روی مجموعه‌ای از کامیت‌ها عمل می‌کنند، نه فقط یک کامیت منفرد.

برای این دستورات، مشخص کردن یک بازبینی منفرد، با استفاده از نشانه‌گذاری توصیف‌شده در بخش پیشین، به معنای مجموعه کامیت‌های قابل دسترسی (reachable) از کامیت داده شده است.

مشخص کردن چندین بازبینی به معنای مجموعه کامیت‌های قابل دسترسی از هر یک از کامیت‌های داده شده است.

مجموعه قابل دسترسی یک کامیت، خود کامیت و کامیت‌های موجود در زنجیره تبار (ancestry chain) آن است.

چندین نشانه‌گذاری برای مشخص کردن مجموعه‌ای از کامیت‌های مرتبط (که "محدوده بازبینی" یا revision range نامیده می‌شود) وجود دارد، که در ادامه نشان داده شده است.

$ git log A..B C..D

---A---B---o---o---C---D

خلاصه محدوده‌های ارجاع (REVISION RANGE SUMMARY)

<rev>

^<rev>

<rev1>..<rev2>

<rev1>...<rev2>

<rev>^@, e.g. HEAD^@

<rev>^!, e.g. HEAD^!

<rev>^-<n>, e.g. HEAD^-, HEAD^-2

در این‌جا چند مثال با استفاده از تصویر لوئلیگر در بالا آورده شده است، که در آن هر مرحله از بسط نشانه‌گذاری و انتخاب کامیت‌ها با دقت توضیح داده شده است:

Args   Expanded arguments    Selected commits
D                            G H D
D F                          G H I J D F
^G D                         H D
^D B                         E I J F B
^D B C                       E I J F B C
C                            I J F C
B..C   = ^B C                C
B...C  = B ^F C              G H D E B C
B^-    = B^..B
       = ^B^1 B              E I J F B
C^@    = C^1
       = F                   I J F
B^@    = B^1 B^2 B^3
       = D E F               D G H E F I J
C^!    = C ^C^@
       = C ^C^1
       = C ^F                C
B^!    = B ^B^@
       = B ^B^1 ^B^2 ^B^3
       = B ^D ^E ^F          B
F^! D  = F ^I ^J D           G H D F

تجزیه گزینه‌ها (PARSEOPT)

در حالت --parseopt، دستور git rev-parse به یکدست‌سازی و پردازش گزینه‌ها کمک می‌کند تا امکاناتی مشابه با توابع توکار C (بخش builtin) را به اسکریپت‌های شل بیاورد. این دستور مانند یک نرمال‌ساز گزینه‌ها عمل می‌کند (برای مثال مقادیر تجمیع‌شده چند سوییچ را تفکیک می‌کند)، تا حدی شبیه به عملکرد getopt(1).

این دستور در ورودی استاندارد مشخصات گزینه‌هایی را که باید تجزیه و درک شوند دریافت می‌کند، و در خروجی استاندارد رشته‌ای مناسب برای دستور eval در sh(1) بازتاب (echo) می‌دهد تا آرگومان‌ها را با آرگومان‌های نرمال‌شده جایگزین کند. در صورت بروز خطا، راهنمای نحوه استفاده (usage) را در خروجی خطای استاندارد نمایش می‌دهد و با کد خروج ۱۲۹ پایان می‌یابد.

یادداشت: هنگام ارسال نتیجه به eval مطمئن شوید که آن را نقل‌قول‌گذاری می‌کنید. برای مشاهده یک نمونه به ادامه متن مراجعه فرمایید.

<opt-spec><flags>*<arg-hint>? SP+ help LF

OPTS_SPEC="\
some-command [<options>] <args>...
some-command does foo and bar!
--
h,help!   show the help
foo       some nifty option --foo
bar=      some cool option --bar with an argument
baz=arg   another cool option --baz with a named argument
qux?path  qux may take a path argument but has meaning by itself
  An option group Header
C?        option C with an optional argument"
eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"

usage: some-command [<options>] <args>...
    some-command does foo and bar!
    -h, --help            show the help
    --[no-]foo            some nifty option --foo
    --[no-]bar ...        some cool option --bar with an argument
    --[no-]baz <arg>      another cool option --baz with a named argument
    --[no-]qux[=<path>]   qux may take a path argument but has meaning by itself
An option group Header
    -C[...]               option C with an optional argument

نقل‌قول شل (SQ-QUOTE)

در حالت --sq-quote، دستور git rev-parse یک خط واحد مناسب برای دستور eval در sh(1) را در خروجی استاندارد بازتاب می‌دهد. این خط از طریق نرمال‌سازی آرگومان‌های بعد از --sq-quote ساخته می‌شود. هیچ کاری به جز نقل‌قول‌گذاری آرگومان‌ها انجام نمی‌شود.

اگر می‌خواهید ورودی دستور پیش از نقل‌قول‌گذاری در شل همچنان طبق معمول توسط git rev-parse تفسیر شود، گزینه --sq را ببینید.

$ cat >your-git-script.sh <<\EOF
#!/bin/sh
args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
command="git frotz -n24 $args"          # and use it inside a handcrafted
                                        # command line
eval "$command"
EOF
$ sh your-git-script.sh "a b'c"

مثال‌ها (EXAMPLES)

$ git rev-parse --verify HEAD

$ git rev-parse --verify --end-of-options $REV^{commit}

$ git rev-parse --default master --verify --end-of-options $REV

همچنین ببینید (SEE ALSO)

git(1)، git-rev-list(1)، git-check-ref-format(1)

گیت (GIT)

بخشی از مجموعه git(1)