[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 <gavinmak@google.com> Commit-Queue: Gavin Mak <gavinmak@google.com> Auto-Submit: Josip Sokcevic <sokcevic@google.com>
4 years ago · f8600e7806
parent f9f7b0ec89
commit f8600e7806
25 changed files with 77 additions and 60 deletions
--- a/man/README.txt
+++ b/man/README.txt
@ -0,0 +1,17 @@
+= Man pages for Depot_tools
+
+This document describes how to write documentation for depot_tools and how to
+deploy it.
+
+== Edit
+
+Only edit files in src/ directories. All other directories (e.g. html, man1) are
+autogenerated and should never be edited manaully.
+
+Once you made modifications to src/ files, run  `./make_docs.sh` in src/
+directory to generate html and man pages.
+
+== Deploy
+
+Run `./push_to_gs.sh` from this directory. If you not have access, ask someone
+from chrome infra to deploy it for you.
--- a/man/html/git-map-branches.html
+++ b/man/html/git-map-branches.html
@ -876,7 +876,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git bmap = map-branches</code></pre>
+  bmap = map-branches</code></pre>
 </div></div>
 </div>
 </div>
@ -899,7 +899,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-nav-downstream.html
+++ b/man/html/git-nav-downstream.html
@ -816,7 +816,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git down = nav-downstream</code></pre>
+  down = nav-downstream</code></pre>
 </div></div>
 </div>
 </div>
@ -839,7 +839,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-nav-upstream.html
+++ b/man/html/git-nav-upstream.html
@ -825,7 +825,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git up = nav-upstream</code></pre>
+  up = nav-upstream</code></pre>
 </div></div>
 </div>
 </div>
@ -848,7 +848,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-new-branch.html
+++ b/man/html/git-new-branch.html
@ -928,8 +928,8 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git nb = new-branch
-  git tb = new-branch --upstream_current  <b>&lt;1&gt;</b></code></pre>
+  nb = new-branch
+  tb = new-branch --upstream_current  <b>&lt;1&gt;</b></code></pre>
 </div></div>
 <div class="colist arabic"><ol>
 <li>
@ -960,7 +960,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-rebase-update.html
+++ b/man/html/git-rebase-update.html
@ -931,7 +931,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git reup = rebase-update</code></pre>
+  reup = rebase-update</code></pre>
 </div></div>
 </div>
 </div>
@ -956,7 +956,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-reparent-branch.html
+++ b/man/html/git-reparent-branch.html
@ -818,7 +818,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git rp = reparent-branch</code></pre>
+  rp = reparent-branch</code></pre>
 </div></div>
 </div>
 </div>
@ -842,7 +842,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-squash-branch.html
+++ b/man/html/git-squash-branch.html
@ -854,7 +854,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git squash = squash-branch</code></pre>
+  squash = squash-branch</code></pre>
 </div></div>
 </div>
 </div>
@ -877,7 +877,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/html/git-upstream-diff.html
+++ b/man/html/git-upstream-diff.html
@ -895,7 +895,7 @@ file.</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>[alias]
-  git udiff = upstream-diff</code></pre>
+  udiff = upstream-diff</code></pre>
 </div></div>
 </div>
 </div>
@ -918,7 +918,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-26 10:54:02 PDT
 </div>
 </div>
 </body>
--- a/man/man1/git-map-branches.1
+++ b/man/man1/git-map-branches.1
@ -2,12 +2,12 @@
 .\"     Title: git-map-branches
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-MAP\-BRANCHES" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-MAP\-BRANCHES" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -190,7 +190,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git bmap = map\-branches
+  bmap = map\-branches
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-nav-downstream.1
+++ b/man/man1/git-nav-downstream.1
@ -2,12 +2,12 @@
 .\"     Title: git-nav-downstream
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-NAV\-DOWNSTREAM" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-NAV\-DOWNSTREAM" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -92,7 +92,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git down = nav\-downstream
+  down = nav\-downstream
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-nav-upstream.1
+++ b/man/man1/git-nav-upstream.1
@ -2,12 +2,12 @@
 .\"     Title: git-nav-upstream
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-NAV\-UPSTREAM" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-NAV\-UPSTREAM" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -102,7 +102,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git up = nav\-upstream
+  up = nav\-upstream
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-new-branch.1
+++ b/man/man1/git-new-branch.1
@ -2,12 +2,12 @@
 .\"     Title: git-new-branch
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-NEW\-BRANCH" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-NEW\-BRANCH" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -184,8 +184,8 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git nb = new\-branch
-  git tb = new\-branch \-\-upstream_current  \fB(1)\fR
+  nb = new\-branch
+  tb = new\-branch \-\-upstream_current  \fB(1)\fR
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-rebase-update.1
+++ b/man/man1/git-rebase-update.1
@ -2,12 +2,12 @@
 .\"     Title: git-rebase-update
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-REBASE\-UPDATE" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-REBASE\-UPDATE" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -157,7 +157,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git reup = rebase\-update
+  reup = rebase\-update
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-reparent-branch.1
+++ b/man/man1/git-reparent-branch.1
@ -2,12 +2,12 @@
 .\"     Title: git-reparent-branch
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-REPARENT\-BRANC" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-REPARENT\-BRANC" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -73,7 +73,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git rp = reparent\-branch
+  rp = reparent\-branch
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-squash-branch.1
+++ b/man/man1/git-squash-branch.1
@ -2,12 +2,12 @@
 .\"     Title: git-squash-branch
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-SQUASH\-BRANCH" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-SQUASH\-BRANCH" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -89,7 +89,7 @@ Optional message to use for the first line of the squashed commit\&. If omitted,
 | * \fB27abea4b40\fR	\fB(spleen_tag\fR\fB) \fR2014\-04\-10 ~ Refactor spleen
 | * \fBd8abe739e3\fR	2014\-04\-10 ~ Add widget
 |/
-* \fBbeec6f4746\fR	\fB(origin/main\fR\fB, origin/HEAD\fR\fB) \fR2014\-04\-10 ~ Make ReflectorImpl use mailboxes    <(\fBfixit, cool_feature\fR)
+* \fBbeec6f4746\fR	\fB(origin/main\fR\fB, origin/HEAD\fR\fB) \fR2014\-04\-10 ~ Make ReflectorImpl use mailboxes    <(\fBcool_feature, fixit\fR)
 * \fB41290e02b7\fR	2014\-04\-10 ~ don\*(Aqt use glibc\-specific execinfo\&.h on uclibc builds
 * \fBa76fde7b7b\fR	2014\-04\-10 ~ [fsp] Add requestUnmount() method together with the request manager\&.
 * \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
 .\}
 .nf
 [alias]
-  git squash = squash\-branch
+  squash = squash\-branch
 .fi
 .if n \{\
 .RE
--- a/man/man1/git-upstream-diff.1
+++ b/man/man1/git-upstream-diff.1
@ -2,12 +2,12 @@
 .\"     Title: git-upstream-diff
 .\"    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/26/2021
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 906b5026
+.\"    Source: depot_tools 5c9e8b47
 .\"  Language: English
 .\"
-.TH "GIT\-UPSTREAM\-DIFF" "1" "07/01/2021" "depot_tools 906b5026" "Chromium depot_tools Manual"
+.TH "GIT\-UPSTREAM\-DIFF" "1" "10/26/2021" "depot_tools 5c9e8b47" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -133,7 +133,7 @@ Some common short\-hand aliases\&. Feel free to add these to your \fI~/\&.gitcon
 .\}
 .nf
 [alias]
-  git udiff = upstream\-diff
+  udiff = upstream\-diff
 .fi
 .if n \{\
 .RE
--- a/man/src/git-map-branches.txt
+++ b/man/src/git-map-branches.txt
@ -52,7 +52,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git bmap = map-branches
+  bmap = map-branches
 ----

 SEE ALSO
--- a/man/src/git-nav-downstream.txt
+++ b/man/src/git-nav-downstream.txt
@ -27,7 +27,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git down = nav-downstream
+  down = nav-downstream
 ----


--- a/man/src/git-nav-upstream.txt
+++ b/man/src/git-nav-upstream.txt
@ -27,7 +27,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git up = nav-upstream
+  up = nav-upstream
 ----

 SEE ALSO
--- a/man/src/git-new-branch.txt
+++ b/man/src/git-new-branch.txt
@ -76,8 +76,8 @@ include::_aliases.txt[]

 ----
 [alias]
-  git nb = new-branch
-  git tb = new-branch --upstream_current  <1>
+  nb = new-branch
+  tb = new-branch --upstream_current  <1>
 ----
 <1> mnemonic: tb -> "track branch"

--- a/man/src/git-rebase-update.txt
+++ b/man/src/git-rebase-update.txt
@ -126,7 +126,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git reup = rebase-update
+  reup = rebase-update
 ----


--- a/man/src/git-reparent-branch.txt
+++ b/man/src/git-reparent-branch.txt
@ -48,7 +48,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git rp = reparent-branch
+  rp = reparent-branch
 ----

 SEE ALSO
--- a/man/src/git-squash-branch.txt
+++ b/man/src/git-squash-branch.txt
@ -46,7 +46,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git squash = squash-branch
+  squash = squash-branch
 ----


--- a/man/src/git-upstream-diff.txt
+++ b/man/src/git-upstream-diff.txt
@ -95,7 +95,7 @@ include::_aliases.txt[]

 ----
 [alias]
-  git udiff = upstream-diff
+  udiff = upstream-diff
 ----

 SEE ALSO