git-interpret-trailers - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

git-interpret-trailers - giúp thêm thông tin có cấu trúc vào thông điệp cam kết

SYNOPSIS

git diễn giải-đoạn giới thiệu [--trim-empty] [(--trailer [(=|:) ])...] [ ...]

MÔ TẢ

Trợ giúp thêm trailer các dòng trông giống với tiêu đề e-mail RFC 822, ở cuối
mặt khác là một phần dạng tự do của thông điệp cam kết.

Lệnh này đọc một số bản vá hoặc thông báo cam kết từ các lập luận hoặc
đầu vào tiêu chuẩn nếu không được quy định. Sau đó, lệnh này áp dụng các đối số được truyền
sử dụng tùy chọn --trailer, nếu có, cho phần thông báo cam kết của mỗi tệp đầu vào. Các
kết quả được phát ra trên đầu ra tiêu chuẩn.

Một số biến cấu hình kiểm soát cách áp dụng các đối số --trailer cho mỗi biến
thông báo cam kết và cách thay đổi bất kỳ đoạn giới thiệu hiện có nào trong thông báo cam kết. Họ
cũng có thể tự động thêm một số đoạn giới thiệu.

Theo mặc định, một = or : đối số được đưa ra bằng cách sử dụng --trailer sẽ là
chỉ được thêm vào sau các đoạn giới thiệu hiện có nếu đoạn giới thiệu cuối cùng có ( ,
) cặp (hoặc nếu không có đoạn giới thiệu hiện có). Các Và các bộ phận sẽ được
được cắt bớt để loại bỏ khoảng trắng bắt đầu và ở cuối, và kết quả được cắt bớt Và
sẽ xuất hiện trong thông báo như thế này:

mã thông báo: giá trị

Điều này có nghĩa là đã cắt tỉa Và sẽ được phân tách bằng ':' (một dấu hai chấm
theo sau là một khoảng trắng).

Theo mặc định, đoạn giới thiệu mới sẽ xuất hiện ở cuối tất cả các đoạn giới thiệu hiện có. Nếu có
không có đoạn giới thiệu hiện có, đoạn giới thiệu mới sẽ xuất hiện sau phần thông báo cam kết của
đầu ra, và nếu không có dòng nào chỉ có khoảng trắng ở cuối phần thông báo cam kết,
một dòng trống sẽ được thêm vào trước đoạn giới thiệu mới.

Các đoạn giới thiệu hiện có được trích xuất từ ​​thông báo đầu vào bằng cách tìm kiếm một nhóm gồm một hoặc
nhiều dòng chứa dấu hai chấm (theo mặc định), trong đó nhóm đứng trước một hoặc nhiều
dòng trống (hoặc chỉ có khoảng trắng). Nhóm phải ở cuối tin nhắn hoặc
các dòng không phải khoảng trắng cuối cùng trước dòng bắt đầu bằng ---. Ba dấu trừ như vậy
bắt đầu phần vá của tin nhắn.

Khi đọc đoạn giới thiệu có thể có khoảng trắng trước và sau mã thông báo, dấu phân cách
và giá trị. Cũng có thể có khoảng trắng bên trong mã thông báo và giá trị.

Lưu ý rằng trailer không tuân theo và không có ý định tuân theo nhiều quy tắc cho RFC 822
tiêu đề. Ví dụ: chúng không tuân theo quy tắc gấp dòng, quy tắc mã hóa và
có lẽ nhiều quy tắc khác.

LỰA CHỌN

--trim-trống
Nếu một phần của bất kỳ đoạn giới thiệu nào chỉ chứa khoảng trắng, toàn bộ đoạn giới thiệu sẽ được
bị xóa khỏi tin nhắn kết quả. Điều này áp dụng cho các xe kéo hiện có cũng như các xe mới
rơ moóc.

--đoạn phim giới thiệu [(=|:) ]
Chỉ định một ( , ) nên được áp dụng làm đoạn giới thiệu cho đầu vào
tin nhắn. Xem mô tả của lệnh này.

CẤU HÌNH BIẾN

trailer.separators
Tùy chọn này cho biết ký tự nào được nhận dạng là dấu phân cách đoạn giới thiệu. Theo mặc định
có thể : được công nhận là dấu phân cách rơ-moóc, ngoại trừ = luôn được chấp nhận trên
dòng lệnh để tương thích với các lệnh git khác.

Ký tự đầu tiên được cung cấp bởi tùy chọn này sẽ là ký tự mặc định được sử dụng khi
một dấu phân cách khác không được chỉ định trong cấu hình cho đoạn giới thiệu này.

Ví dụ: nếu giá trị cho tùy chọn này là "%=$", thì chỉ những dòng sử dụng định dạng
với chứa đựng %, = or $ và sau đó không gian sẽ được xem xét
xe kéo. Và % sẽ là dấu phân cách mặc định được sử dụng, do đó, theo mặc định, các đoạn giới thiệu sẽ xuất hiện
như: % (một dấu phần trăm và một dấu cách sẽ xuất hiện giữa mã thông báo
và giá trị).

trailer.where
Tùy chọn này cho biết nơi đoạn giới thiệu mới sẽ được thêm vào.

Đây có thể là kết thúc, là mặc định, bắt đầu, sau hoặc trước.

Nếu hết thì mỗi đoạn giới thiệu mới sẽ xuất hiện ở cuối các đoạn giới thiệu hiện có.

Nếu là phần bắt đầu thì mỗi đoạn giới thiệu mới sẽ xuất hiện ở phần đầu, thay vì phần cuối của
các xe kéo hiện có.

Nếu đến sau thì mỗi đoạn giới thiệu mới sẽ xuất hiện ngay sau đoạn giới thiệu cuối cùng có nội dung
như nhau .

Nếu là trước đó thì mỗi đoạn giới thiệu mới sẽ xuất hiện ngay trước đoạn giới thiệu đầu tiên với
giống nhau .

trailer.ifexists
Tùy chọn này giúp bạn có thể chọn hành động nào sẽ được thực hiện khi có
đã có ít nhất một đoạn giới thiệu giống nhau trong tin nhắn.

Các giá trị hợp lệ cho tùy chọn này là: addIfDifferentNeighbor (đây là mặc định),
addIfDifferent, thêm, ghi đè hoặc doNothing.

Với addIfDifferentNeighbor, một đoạn giới thiệu mới sẽ chỉ được thêm nếu không có đoạn giới thiệu nào có
như nhau ( , ) nằm ở trên hoặc dưới đường nơi đoạn giới thiệu mới sẽ xuất hiện
thêm vào.

Với addIfDifferent, một đoạn giới thiệu mới sẽ chỉ được thêm vào nếu không có đoạn giới thiệu nào giống nhau
( , ) cặp đã có trong tin nhắn.

Với tính năng thêm, một đoạn giới thiệu mới sẽ được thêm vào, ngay cả khi một số đoạn giới thiệu có cùng ( ,
) cặp đã có trong tin nhắn.

Với việc thay thế, một đoạn giới thiệu hiện có có cùng nội dung sẽ bị xóa và cái mới
trailer sẽ được thêm vào. Đoạn giới thiệu đã xóa sẽ là đoạn giới thiệu gần nhất (có cùng
) đến nơi cái mới sẽ được thêm vào.

Với doNothing, sẽ không có gì được thực hiện; đó là sẽ không có đoạn giới thiệu mới nào được thêm vào nếu có
đã là một với điều tương tự trong tin nhắn.

trailer.ifmissing
Tùy chọn này giúp bạn có thể chọn hành động nào sẽ được thực hiện khi có
chưa có đoạn giới thiệu nào giống nhau trong tin nhắn.

Các giá trị hợp lệ cho tùy chọn này là: add (đây là giá trị mặc định) và doNothing.

Với phần thêm, một đoạn giới thiệu mới sẽ được thêm vào.

Với doNothing, sẽ không có gì được thực hiện.

đoạn phim giới thiệu. .chìa khóa
Chìa khóa này sẽ được sử dụng thay vì trong xe kéo. Ở cuối khóa này, một
dấu phân cách có thể xuất hiện và sau đó là một số ký tự khoảng trắng. Theo mặc định, chỉ hợp lệ
dấu phân cách là :, nhưng điều này có thể được thay đổi bằng cách sử dụng biến cấu hình trailer.separators.

Nếu có dấu phân cách thì khóa sẽ được sử dụng thay cho cả hai và
dấu phân cách mặc định khi thêm đoạn giới thiệu.

đoạn phim giới thiệu. .Ở đâu
Tùy chọn này có cùng giá trị với trailer.where biến cấu hình và nó
ghi đè những gì được chỉ định bởi tùy chọn đó cho các đoạn giới thiệu có thông tin được chỉ định .

đoạn phim giới thiệu. .nếu tồn tại
Tùy chọn này có cùng giá trị với trailer.ifexist biến cấu hình và nó
ghi đè những gì được chỉ định bởi tùy chọn đó cho các đoạn giới thiệu có thông tin được chỉ định .

đoạn phim giới thiệu. .if thiếu
Tùy chọn này có cùng giá trị với trailer.ifmissing biến cấu hình và
nó ghi đè những gì được chỉ định bởi tùy chọn đó cho các đoạn giới thiệu có thông số được chỉ định .

đoạn phim giới thiệu. .yêu cầu
Tùy chọn này có thể được sử dụng để chỉ định lệnh shell sẽ được gọi tới
tự động thêm hoặc sửa đổi đoạn giới thiệu với thông tin được chỉ định .

Khi tùy chọn này được chỉ định, hành vi này giống như một đặc biệt =
đối số đã được thêm vào đầu dòng lệnh, trong đó được coi là
đầu ra tiêu chuẩn của lệnh được chỉ định với bất kỳ khoảng trắng ở đầu và cuối
tỉa.

Nếu lệnh chứa chuỗi $ARG, chuỗi này sẽ được thay thế bằng chuỗi
một phần của trailer hiện có với cùng một , nếu có, trước lệnh
đưa ra.

Nếu một vài = các đối số cũng được truyền trên dòng lệnh, khi một
đoạn phim giới thiệu. .yêu cầu được cấu hình, lệnh cũng sẽ được thực thi cho mỗi
những lập luận này. Và một phần của những lập luận này, nếu có, sẽ được sử dụng để
thay thế chuỗi $ARG trong lệnh.

VÍ DỤ

· Cấu hình một đăng ký xe kéo với một Được ký bởi key, sau đó thêm hai đoạn giới thiệu này
đến một tin nhắn:

$ git config trailer.sign.key "Người đăng xuất"
$ tin nhắn mèo.txt
Tiêu đề

tin nhắn
$ tin nhắn mèo.txt | git thông dịch-trailers --trailer 'ký: Alice[email được bảo vệ]>' --trailer 'ký tên: Bob[email được bảo vệ]>'
Tiêu đề

tin nhắn

Người ký tên: Alice[email được bảo vệ]>
Người ký tên: Bob[email được bảo vệ]>

· Trích xuất cam kết cuối cùng dưới dạng bản vá và thêm một Cc và Xét bởi trailer của nó:

$ git định dạng vá lỗi -1
0001-foo.patch
$ git thông dịch-trailers --trailer 'Cc: Alice[email được bảo vệ]>' --trailer 'Người đánh giá: Bob[email được bảo vệ]>' 0001-foo.patch >0001-bar.patch

· Cấu hình một đăng ký đoạn giới thiệu có lệnh tự động thêm 'Người đăng xuất:' bằng
thông tin về tác giả chỉ khi chưa có 'Signed-off-by: ' và chỉ ra cách thực hiện
công trình:

$ git config trailer.sign.key "Người đăng xuất: "
$ git config trailer.sign.ifmissing thêm
$ git config trailer.sign.ifexists doNothing
$ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'
$ git thông dịch-trailer <
> EOF

Người ký tên: Bob[email được bảo vệ]>
$ git thông dịch-trailer <
> Người đăng ký: Alice[email được bảo vệ]>
> EOF

Người ký tên: Alice[email được bảo vệ]>

· Cấu hình một sửa chữa trailer có chìa khóa chứa một # và không có khoảng trống sau này
ký tự và cho thấy nó hoạt động như thế nào:

$ git config trailer.separators ":#"
$ git config trailer.fix.key "Sửa #"
$ echo "chủ đề" | git thông dịch-trailers --trailer fix=42
Tiêu đề

Sửa lỗi #42

· Cấu hình một xem đoạn giới thiệu có lệnh hiển thị chủ đề của một cam kết
liên quan và cho thấy nó hoạt động như thế nào:

$ git config trailer.see.key "Xem thêm: "
$ git config trailer.see.ifExists "thay thế"
$ git config trailer.see.ifThiếu "doNothing"
$ git config trailer.see.command "git log -1 --oneline --format=\"%h (%s)\" --abbrev-commit --abbrev=14 \$ARG"
$ git thông dịch-trailer <
> chủ đề
>
> tin nhắn
>
> xem: ĐẦU~2
> EOF
Tiêu đề

tin nhắn

Xem thêm: fe3187489d69c4 (chủ đề của cam kết liên quan)

· Định cấu hình mẫu cam kết với một số đoạn giới thiệu có giá trị trống (sử dụng sed để hiển thị
và giữ khoảng trắng ở cuối đoạn giới thiệu), sau đó định cấu hình thông báo cam kết
móc sử dụng git diễn giải-đoạn giới thiệu để xóa các đoạn giới thiệu có giá trị trống và thêm
a phiên bản git Trailer:

$ sed -e 's/ Z$/ /' >commit_template.txt <
> ***chủ đề***
>
> ***tin nhắn***
>
> Sửa lỗi: Z
> Cc: Z
> Người đánh giá: Z
> Người đăng ký: Z
> EOF
$ git config commit.template commit_template.txt
$ cat >.git/hooks/commit-msg <
> #!/ Bin / sh
> git thông dịch-trailers --trim-empty --trailer "git-version: \$(git mô tả)" "\$1" > "\$1.new"
> mv "\$1.mới" "\$1"
> EOF
$ chmod +x .git/hooks/commit-msg

Sử dụng git-interpret-trailers trực tuyến bằng dịch vụ onworks.net