نام (NAME)

git-format-rev - قالب‌بندی شناسه‌های ارجاع و بازبینی گیت

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

(EXPERIMENTAL!) git format-rev --stdin-mode=<mode> --format=<pretty> [--[no-]notes=<ref>] [-z] [--[no-]null-output] [--[no-]null-input]

توضیحات (DESCRIPTION)

قالب‌بندی سفارشی بازبینی‌ها (revisions) از ورودی استاندارد.

این دستور آزمایشی است. رفتار آن ممکن است در آینده تغییر کند.

گزینه‌ها (OPTIONS)

--stdin-mode=<mode>

--format=<pretty>

--notes=<ref>, --no-notes

-z, --null

--null-output, --no-null-output

--null-input, --no-null-input

قالب ورودی و خروجی (INPUT AND OUTPUT FORMAT)

این دستور به‌طور پیش‌فرض از خط جدید برای پایان دادن به ورودی و خروجی استفاده می‌کند. برای استفاده از نویسه NUL به عنوان پایان‌دهنده، گزینه‌های -z، --null-output و --null-input را ببینید.

حالت --stdin-mode=revs یک کامیت قالب‌بندی‌شده را به همراه پایان‌دهنده در خروجی درج می‌کند. این را می‌توان یک خط یا یک رکورد نامید (در صورتی که واژه «خط» بیش از حد تداعی‌کننده پایان با خط جدید باشد).

توجه داشته باشید که این بدان معناست که نویسه پایان‌دهنده (خط جدید یا NUL) به عنوان یک پایان‌دهنده (terminator) عمل می‌کند، نه یک جداکننده (separator). به عبارت دیگر، آخرین خط یا رکورد نیز با نویسه پایان‌دهنده خاتمه می‌یابد.

حالت --stdin-mode=text هر نام شیء را با کامیت قالب‌بندی‌شده جایگزین می‌کند؛ به عنوان مثال قالب %s یک نام شیء کامیت را بدون هیچ نویسه پایانی به <subject> تبدیل می‌کند. مانند این:

Did we not fix this in "<subject>"?

خواندن و نوشتن تعاملی با این دستور ایمن است زیرا هر رکورد بلافاصله فلاش و تخلیه (flush) می‌شود.

مثال‌ها (EXAMPLES)

دستور git-last-modified(1) کامیتی را نشان می‌دهد که هر فایل آخرین بار در آن تغییر یافته است.

$ git last-modified -- README.md Makefile
7798034171030be0909c56377a4e0e10e6d2df93        Makefile
c50fbb2dd225e7e82abba4380423ae105089f4d7        README.md

می‌توانیم خروجی را به این دستور هدایت (pipe) کنیم تا نام شیء با نویسنده کامیت جایگزین شود.

$ git last-modified -- README.md Makefile |
    git format-rev --stdin-mode=text --format=%an
Junio C Hamano  Makefile
Todd Zullinger  README.md

مثال دیگر قالب‌بندی کامیت‌ها در پیام‌های کامیت است. با فرض داشتن این پیام کامیت:

Fix off-by-one error
Fix off-by-one error introduced in
e83c5163316f89bfbde7d9ab23ca2e25604af290.
We thought we fixed this in 5569bf9bbedd63a00780fc5c110e0cfab3aa97b9 but
that only covered 1/3 of the faulty cases.

می‌توانیم کامیت‌ها را قالب‌بندی کرده و از par(1) برای بازآرایی متن استفاده کنیم، مثلاً در یک قلاب commit-msg:

$ git config set hook.reference-commits.event commit-msg
$ git config set hook.reference-commits.command reference-commits
$ cat $(which reference-commits)
#/bin/sh
msg="$1"
rewritten=$(mktemp)
git format-rev --stdin-mode=text --format=reference <"$msg" |
    par >"$rewritten"
mv "$rewritten" "$msg"

که نتیجه‌ای شبیه به این تولید خواهد کرد:

Fix off-by-one error
Fix off-by-one error introduced in e83c5163316 (Implement better memory
allocator, 2005-04-07).
We thought we fixed this in 5569bf9bbed (Fix memory allocator,
2005-06-22) but that only covered 1/3 of the faulty cases.

بحث و بررسی (DISCUSSION)

این دستور به شما امکان می‌دهد هر تعداد بازبینی را با هر ترتیبی تنها با یک بار اجرای دستور قالب‌بندی کنید. مورد git-last-modified(1) در بخش مثال‌های بالا را در نظر بگیرید:

دو دستور پرکاربرد که کامیت‌ها را به شکل سفارشی قالب‌بندی می‌کنند git-log(1) و git-show(1) هستند. مشخص شده است که آن‌ها برای مورد کاربرد بالا چندان مناسب نیستند.

به طور خلاصه، استفاده از این دو دستور در صورتی که برای هر خط از یک فرآیند استفاده کنید سرراست است. در صورتی که بخواهید تنها از یک فرآیند استفاده کنید کار بسیار بیشتری می‌طلبد، هرچند همچنان امکان‌پذیر است. در مقابل، این مشکل با استفاده از این دستور تنها با یک خط‌لوله ساده دیگر در پوسته حل می‌شود.

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

git-name-rev(1), git-log(1).

گیت (GIT)

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