From 29521bc672082ba1a23bf522cb56653acb452fa0 Mon Sep 17 00:00:00 2001 From: Josip Sokcevic Date: Tue, 5 Oct 2021 18:58:27 +0000 Subject: [PATCH] Use main ref in git-footers documentation R=gavinmak@google.com Fixed: 1118433 Change-Id: I15948b319ed847dce0d4222fcaad7fdf4620360c Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/3205608 Auto-Submit: Josip Sokcevic Reviewed-by: Gavin Mak Commit-Queue: Gavin Mak --- man/html/git-footers.html | 14 +++++++------- man/man1/git-footers.1 | 18 +++++++++--------- man/src/git-footers.demo.1.sh | 2 +- man/src/git-footers.txt | 6 +++--- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/man/html/git-footers.html b/man/html/git-footers.html index 4714379bf..cb4cb73a7 100644 --- a/man/html/git-footers.html +++ b/man/html/git-footers.html @@ -774,7 +774,7 @@ commit might look like:

-
Cr-Commit-Position: refs/heads/master@{#292272}
+
Cr-Commit-Position: refs/heads/main@{#292272}
 Tech-Debt-Introduced: 17 nanoMSOffices

git footers knows how to extract this information.

@@ -810,7 +810,7 @@ case-normalized.

-
refs/heads/master@{#292272}
+
refs/heads/main@{#292272}
 refs/branch-heads/branchname
@@ -829,7 +829,7 @@ refs/branch-heads/branchname

Extracts and prints the Chrome commit position ref name only - (ref/heads/master or refs/branch-heads/branchname in the example above). + (ref/heads/main or refs/branch-heads/branchname in the example above).

@@ -841,16 +841,16 @@ refs/branch-heads/branchname 

$ git footers HEAD
 Tech-Debt-Introduced: -4 microMSOffices
 Tech-Debt-Introduced: 17 microMSOffices
-Cr-Commit-Position: refs/heads/master@{#292272}
+Cr-Commit-Position: refs/heads/main@{#292272}
 $ git footers --key Tech-Debt-Introduced HEAD
 -4 microMSOffices
 17 microMSOffices
 $ git footers --position HEAD
-refs/heads/master@{#292272}
+refs/heads/main@{#292272}
 $ git footers --position-num HEAD
 292272
 $ git footers --position-ref HEAD
-refs/heads/master
+refs/heads/main

@@ -873,7 +873,7 @@ by checking out the
Last updated - 2021-07-01 07:07:00 PDT + 2021-10-05 09:49:24 PDT
diff --git a/man/man1/git-footers.1 b/man/man1/git-footers.1 index 8571ad372..b6f1d7819 100644 --- a/man/man1/git-footers.1 +++ b/man/man1/git-footers.1 @@ -2,12 +2,12 @@ .\" Title: git-footers .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 07/01/2021 +.\" Date: 10/05/2021 .\" Manual: Chromium depot_tools Manual -.\" Source: depot_tools 906b5026 +.\" Source: depot_tools a594dbdd .\" Language: English .\" -.TH "GIT\-FOOTERS" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual" +.TH "GIT\-FOOTERS" "1" "10/05/2021" "depot_tools a594dbdd" "Chromium depot_tools Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -54,7 +54,7 @@ This is a fancy commit message\&. .RS 4 .\} .nf -Cr\-Commit\-Position: refs/heads/master@{#292272} +Cr\-Commit\-Position: refs/heads/main@{#292272} Tech\-Debt\-Introduced: 17 nanoMSOffices .fi .if n \{\ @@ -84,7 +84,7 @@ footer\&. If that doesn\(cqt exist then it tries a heuristic based on .RS 4 .\} .nf -refs/heads/master@{#292272} +refs/heads/main@{#292272} refs/branch\-heads/branchname .fi .if n \{\ @@ -99,7 +99,7 @@ Extracts and prints the Chrome commit position number only (292272 in the exampl .PP \-\-position\-ref .RS 4 -Extracts and prints the Chrome commit position ref name only (\fBref/heads/master\fR +Extracts and prints the Chrome commit position ref name only (\fBref/heads/main\fR or \fBrefs/branch\-heads/branchname\fR in the example above)\&. @@ -115,16 +115,16 @@ in the example above)\&. \fB$ git footers HEAD\fR Tech\-Debt\-Introduced: \-4 microMSOffices Tech\-Debt\-Introduced: 17 microMSOffices -Cr\-Commit\-Position: refs/heads/master@{#292272} +Cr\-Commit\-Position: refs/heads/main@{#292272} \fB$ git footers \-\-key Tech\-Debt\-Introduced HEAD\fR \-4 microMSOffices 17 microMSOffices \fB$ git footers \-\-position HEAD\fR -refs/heads/master@{#292272} +refs/heads/main@{#292272} \fB$ git footers \-\-position\-num HEAD\fR 292272 \fB$ git footers \-\-position\-ref HEAD\fR -refs/heads/master +refs/heads/main .fi .if n \{\ .RE diff --git a/man/src/git-footers.demo.1.sh b/man/src/git-footers.demo.1.sh index fb596b975..c6a2c6f5a 100755 --- a/man/src/git-footers.demo.1.sh +++ b/man/src/git-footers.demo.1.sh @@ -6,7 +6,7 @@ add unstaged_deleted_file add modified_file c 'I committed this and am proud of it. -Cr-Commit-Position: refs/heads/master@{#292272} +Cr-Commit-Position: refs/heads/main@{#292272} Tech-Debt-Introduced: 17 microMSOffices Tech-Debt-Introduced: -4 microMSOffices' diff --git a/man/src/git-footers.txt b/man/src/git-footers.txt index e7274e103..005f8761d 100644 --- a/man/src/git-footers.txt +++ b/man/src/git-footers.txt @@ -21,7 +21,7 @@ commit might look like: This is a fancy commit message. - Cr-Commit-Position: refs/heads/master@{#292272} + Cr-Commit-Position: refs/heads/main@{#292272} Tech-Debt-Introduced: 17 nanoMSOffices `git footers` knows how to extract this information. @@ -46,7 +46,7 @@ case-normalized. then it tries a heuristic based on `Git-Svn-Id`. Output is in one of the following forms: - refs/heads/master@{#292272} + refs/heads/main@{#292272} refs/branch-heads/branchname --position-num:: @@ -55,7 +55,7 @@ case-normalized. --position-ref:: Extracts and prints the Chrome commit position ref name only - (`ref/heads/master` or `refs/branch-heads/branchname` in the example above). + (`ref/heads/main` or `refs/branch-heads/branchname` in the example above). EXAMPLE