Skip to content

Commit f8600e7

Browse files
sokcevicGLUCI CQ
authored and
LUCI CQ
committed
[docs] Fix alias settings
When using alias, we no longer can't nor need to prefix command with git. This change updates all [alias] blocks and removes git from it. Change-Id: Id89142ef86935e04e21872ce61fb63a511ed40a7 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/3244473 Reviewed-by: Gavin Mak <[email protected]> Commit-Queue: Gavin Mak <[email protected]> Auto-Submit: Josip Sokcevic <[email protected]>
1 parent f9f7b0e commit f8600e7

25 files changed

+77
-60
lines changed

man/README.txt

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
= Man pages for Depot_tools
2+
3+
This document describes how to write documentation for depot_tools and how to
4+
deploy it.
5+
6+
== Edit
7+
8+
Only edit files in src/ directories. All other directories (e.g. html, man1) are
9+
autogenerated and should never be edited manaully.
10+
11+
Once you made modifications to src/ files, run `./make_docs.sh` in src/
12+
directory to generate html and man pages.
13+
14+
== Deploy
15+
16+
Run `./push_to_gs.sh` from this directory. If you not have access, ask someone
17+
from chrome infra to deploy it for you.

man/html/git-map-branches.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -876,7 +876,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
876876
<div class="listingblock">
877877
<div class="content">
878878
<pre><code>[alias]
879-
git bmap = map-branches</code></pre>
879+
bmap = map-branches</code></pre>
880880
</div></div>
881881
</div>
882882
</div>
@@ -899,7 +899,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
899899
<div id="footer">
900900
<div id="footer-text">
901901
Last updated
902-
2021-07-01 07:07:00 PDT
902+
2021-10-26 10:54:02 PDT
903903
</div>
904904
</div>
905905
</body>

man/html/git-nav-downstream.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
816816
<div class="listingblock">
817817
<div class="content">
818818
<pre><code>[alias]
819-
git down = nav-downstream</code></pre>
819+
down = nav-downstream</code></pre>
820820
</div></div>
821821
</div>
822822
</div>
@@ -839,7 +839,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
839839
<div id="footer">
840840
<div id="footer-text">
841841
Last updated
842-
2021-07-01 07:07:00 PDT
842+
2021-10-26 10:54:02 PDT
843843
</div>
844844
</div>
845845
</body>

man/html/git-nav-upstream.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -825,7 +825,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
825825
<div class="listingblock">
826826
<div class="content">
827827
<pre><code>[alias]
828-
git up = nav-upstream</code></pre>
828+
up = nav-upstream</code></pre>
829829
</div></div>
830830
</div>
831831
</div>
@@ -848,7 +848,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
848848
<div id="footer">
849849
<div id="footer-text">
850850
Last updated
851-
2021-07-01 07:07:00 PDT
851+
2021-10-26 10:54:02 PDT
852852
</div>
853853
</div>
854854
</body>

man/html/git-new-branch.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -928,8 +928,8 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
928928
<div class="listingblock">
929929
<div class="content">
930930
<pre><code>[alias]
931-
git nb = new-branch
932-
git tb = new-branch --upstream_current <b>&lt;1&gt;</b></code></pre>
931+
nb = new-branch
932+
tb = new-branch --upstream_current <b>&lt;1&gt;</b></code></pre>
933933
</div></div>
934934
<div class="colist arabic"><ol>
935935
<li>
@@ -960,7 +960,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
960960
<div id="footer">
961961
<div id="footer-text">
962962
Last updated
963-
2021-07-01 07:07:00 PDT
963+
2021-10-26 10:54:02 PDT
964964
</div>
965965
</div>
966966
</body>

man/html/git-rebase-update.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -931,7 +931,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
931931
<div class="listingblock">
932932
<div class="content">
933933
<pre><code>[alias]
934-
git reup = rebase-update</code></pre>
934+
reup = rebase-update</code></pre>
935935
</div></div>
936936
</div>
937937
</div>
@@ -956,7 +956,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
956956
<div id="footer">
957957
<div id="footer-text">
958958
Last updated
959-
2021-07-01 07:07:00 PDT
959+
2021-10-26 10:54:02 PDT
960960
</div>
961961
</div>
962962
</body>

man/html/git-reparent-branch.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
818818
<div class="listingblock">
819819
<div class="content">
820820
<pre><code>[alias]
821-
git rp = reparent-branch</code></pre>
821+
rp = reparent-branch</code></pre>
822822
</div></div>
823823
</div>
824824
</div>
@@ -842,7 +842,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
842842
<div id="footer">
843843
<div id="footer-text">
844844
Last updated
845-
2021-07-01 07:07:00 PDT
845+
2021-10-26 10:54:02 PDT
846846
</div>
847847
</div>
848848
</body>

man/html/git-squash-branch.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -854,7 +854,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
854854
<div class="listingblock">
855855
<div class="content">
856856
<pre><code>[alias]
857-
git squash = squash-branch</code></pre>
857+
squash = squash-branch</code></pre>
858858
</div></div>
859859
</div>
860860
</div>
@@ -877,7 +877,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
877877
<div id="footer">
878878
<div id="footer-text">
879879
Last updated
880-
2021-07-01 07:07:00 PDT
880+
2021-10-26 10:54:02 PDT
881881
</div>
882882
</div>
883883
</body>

man/html/git-upstream-diff.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -895,7 +895,7 @@ <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
895895
<div class="listingblock">
896896
<div class="content">
897897
<pre><code>[alias]
898-
git udiff = upstream-diff</code></pre>
898+
udiff = upstream-diff</code></pre>
899899
</div></div>
900900
</div>
901901
</div>
@@ -918,7 +918,7 @@ <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
918918
<div id="footer">
919919
<div id="footer-text">
920920
Last updated
921-
2021-07-01 07:07:00 PDT
921+
2021-10-26 10:54:02 PDT
922922
</div>
923923
</div>
924924
</body>

man/man1/git-map-branches.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-map-branches
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-MAP\-BRANCHES" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-MAP\-BRANCHES" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -190,7 +190,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
190190
.\}
191191
.nf
192192
[alias]
193-
git bmap = map\-branches
193+
bmap = map\-branches
194194
.fi
195195
.if n \{\
196196
.RE

man/man1/git-nav-downstream.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-nav-downstream
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-NAV\-DOWNSTREAM" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-NAV\-DOWNSTREAM" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -92,7 +92,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
9292
.\}
9393
.nf
9494
[alias]
95-
git down = nav\-downstream
95+
down = nav\-downstream
9696
.fi
9797
.if n \{\
9898
.RE

man/man1/git-nav-upstream.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-nav-upstream
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-NAV\-UPSTREAM" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-NAV\-UPSTREAM" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -102,7 +102,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
102102
.\}
103103
.nf
104104
[alias]
105-
git up = nav\-upstream
105+
up = nav\-upstream
106106
.fi
107107
.if n \{\
108108
.RE

man/man1/git-new-branch.1

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-new-branch
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-NEW\-BRANCH" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-NEW\-BRANCH" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -184,8 +184,8 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
184184
.\}
185185
.nf
186186
[alias]
187-
git nb = new\-branch
188-
git tb = new\-branch \-\-upstream_current \fB(1)\fR
187+
nb = new\-branch
188+
tb = new\-branch \-\-upstream_current \fB(1)\fR
189189
.fi
190190
.if n \{\
191191
.RE

man/man1/git-rebase-update.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-rebase-update
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-REBASE\-UPDATE" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-REBASE\-UPDATE" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -157,7 +157,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
157157
.\}
158158
.nf
159159
[alias]
160-
git reup = rebase\-update
160+
reup = rebase\-update
161161
.fi
162162
.if n \{\
163163
.RE

man/man1/git-reparent-branch.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-reparent-branch
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-REPARENT\-BRANC" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-REPARENT\-BRANC" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -73,7 +73,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
7373
.\}
7474
.nf
7575
[alias]
76-
git rp = reparent\-branch
76+
rp = reparent\-branch
7777
.fi
7878
.if n \{\
7979
.RE

man/man1/git-squash-branch.1

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-squash-branch
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-SQUASH\-BRANCH" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-SQUASH\-BRANCH" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -89,7 +89,7 @@ Optional message to use for the first line of the squashed commit\&. If omitted,
8989
| * \fB27abea4b40\fR \fB(spleen_tag\fR\fB) \fR2014\-04\-10 ~ Refactor spleen
9090
| * \fBd8abe739e3\fR 2014\-04\-10 ~ Add widget
9191
|/
92-
* \fBbeec6f4746\fR \fB(origin/main\fR\fB, origin/HEAD\fR\fB) \fR2014\-04\-10 ~ Make ReflectorImpl use mailboxes <(\fBfixit, cool_feature\fR)
92+
* \fBbeec6f4746\fR \fB(origin/main\fR\fB, origin/HEAD\fR\fB) \fR2014\-04\-10 ~ Make ReflectorImpl use mailboxes <(\fBcool_feature, fixit\fR)
9393
* \fB41290e02b7\fR 2014\-04\-10 ~ don\*(Aqt use glibc\-specific execinfo\&.h on uclibc builds
9494
* \fBa76fde7b7b\fR 2014\-04\-10 ~ [fsp] Add requestUnmount() method together with the request manager\&.
9595
* \fB9de7a713b3\fR 2014\-04\-10 ~ linux_aura: Use system configuration for middle clicking the titlebar\&.
@@ -110,7 +110,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
110110
.\}
111111
.nf
112112
[alias]
113-
git squash = squash\-branch
113+
squash = squash\-branch
114114
.fi
115115
.if n \{\
116116
.RE

man/man1/git-upstream-diff.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: git-upstream-diff
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 07/01/2021
5+
.\" Date: 10/26/2021
66
.\" Manual: Chromium depot_tools Manual
7-
.\" Source: depot_tools 906b5026
7+
.\" Source: depot_tools 5c9e8b47
88
.\" Language: English
99
.\"
10-
.TH "GIT\-UPSTREAM\-DIFF" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
10+
.TH "GIT\-UPSTREAM\-DIFF" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -133,7 +133,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
133133
.\}
134134
.nf
135135
[alias]
136-
git udiff = upstream\-diff
136+
udiff = upstream\-diff
137137
.fi
138138
.if n \{\
139139
.RE

man/src/git-map-branches.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ include::_aliases.txt[]
5252

5353
----
5454
[alias]
55-
git bmap = map-branches
55+
bmap = map-branches
5656
----
5757

5858
SEE ALSO

man/src/git-nav-downstream.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ include::_aliases.txt[]
2727
2828
----
2929
[alias]
30-
git down = nav-downstream
30+
down = nav-downstream
3131
----
3232
3333

0 commit comments

Comments
 (0)