InTheForest/chromium_depot_tools
1
0
Fork 0
mirror of https://chromium.googlesource.com/chromium/tools/depot_tools.git synced 2026-01-11 10:41:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use main ref in git-footers documentation

Browse Source 
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 <sokcevic@google.com>
Reviewed-by: Gavin Mak <gavinmak@google.com>
Commit-Queue: Gavin Mak <gavinmak@google.com>
This commit is contained in:
Josip Sokcevic
2021-10-05 18:58:27 +00:00
committed by LUCI CQ
parent 7253c59443
commit 29521bc672
4 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
man/html/git-footers.html
View File

@@ -774,7 +774,7 @@ commit might look like:</p></div>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Cr-Commit-Position: refs/heads/master@{#292272}
<pre><code>Cr-Commit-Position: refs/heads/main@{#292272}
Tech-Debt-Introduced: 17 nanoMSOffices</code></pre>
</div></div>
<div class="paragraph"><p><code>git footers</code> knows how to extract this information.</p></div>
@@ -810,7 +810,7 @@ case-normalized.</p></div>
</p>
<div class="literalblock">
<div class="content">
<pre><code>refs/heads/master@{#292272}
<pre><code>refs/heads/main@{#292272}
refs/branch-heads/branchname</code></pre>
</div></div>
</dd>
@@ -829,7 +829,7 @@ refs/branch-heads/branchname</code></pre>
<dd>
<p>
Extracts and prints the Chrome commit position ref name only
(<code>ref/heads/master</code> or <code>refs/branch-heads/branchname</code> in the example above).
(<code>ref/heads/main</code> or <code>refs/branch-heads/branchname</code> in the example above).
</p>
</dd>
</dl></div>
@@ -841,16 +841,16 @@ refs/branch-heads/branchname</code></pre>
<div class="paragraph"><p></p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #ffffff">$ git footers HEAD</span>
Tech-Debt-Introduced: -4 microMSOffices
Tech-Debt-Introduced: 17 microMSOffices
Cr-Commit-Position: refs/heads/master@{#292272}
Cr-Commit-Position: refs/heads/main@{#292272}
<span style="font-weight: bold; color: #ffffff">$ git footers --key Tech-Debt-Introduced HEAD</span>
-4 microMSOffices
17 microMSOffices
<span style="font-weight: bold; color: #ffffff">$ git footers --position HEAD</span>
refs/heads/master@{#292272}
refs/heads/main@{#292272}
<span style="font-weight: bold; color: #ffffff">$ git footers --position-num HEAD</span>
292272
<span style="font-weight: bold; color: #ffffff">$ git footers --position-ref HEAD</span>
refs/heads/master
refs/heads/main
</code></pre></div></div><p><div class="paragraph"></p></div>
</div>
</div>
@@ -873,7 +873,7 @@ by checking out the <a href="https://chromium.googlesource.com/chromium/tools/de
<div id="footer">
<div id="footer-text">
Last updated
2021-07-01 07:07:00 PDT
2021-10-05 09:49:24 PDT
</div>
</div>
</body>

18
man/man1/git-footers.1
View File

@@ -2,12 +2,12 @@
.\" Title: git-footers
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" 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

2
man/src/git-footers.demo.1.sh
View File

@@ -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'

6
man/src/git-footers.txt
View File

@@ -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