diff --git a/man/README.txt b/man/README.txt new file mode 100644 index 000000000..2e8d5441d --- /dev/null +++ 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. diff --git a/man/html/git-map-branches.html b/man/html/git-map-branches.html index 0f2fb77cc..28b2bf3ca 100644 --- a/man/html/git-map-branches.html +++ b/man/html/git-map-branches.html @@ -876,7 +876,7 @@ file.

[alias]
-  git bmap = map-branches
+ bmap = map-branches
@@ -899,7 +899,7 @@ by checking out the diff --git a/man/html/git-nav-downstream.html b/man/html/git-nav-downstream.html index faa1654d0..2c2d369f8 100644 --- a/man/html/git-nav-downstream.html +++ b/man/html/git-nav-downstream.html @@ -816,7 +816,7 @@ file.

[alias]
-  git down = nav-downstream
+ down = nav-downstream
@@ -839,7 +839,7 @@ by checking out the
diff --git a/man/html/git-nav-upstream.html b/man/html/git-nav-upstream.html index b7b9c7ddf..6d26f4e29 100644 --- a/man/html/git-nav-upstream.html +++ b/man/html/git-nav-upstream.html @@ -825,7 +825,7 @@ file.

[alias]
-  git up = nav-upstream
+ up = nav-upstream
@@ -848,7 +848,7 @@ by checking out the
diff --git a/man/html/git-new-branch.html b/man/html/git-new-branch.html index 23d51f4f7..739da1a64 100644 --- a/man/html/git-new-branch.html +++ b/man/html/git-new-branch.html @@ -928,8 +928,8 @@ file.

[alias]
-  git nb = new-branch
-  git tb = new-branch --upstream_current  <1>
+ nb = new-branch + tb = new-branch --upstream_current <1>
  1. @@ -960,7 +960,7 @@ by checking out the
diff --git a/man/html/git-rebase-update.html b/man/html/git-rebase-update.html index 779383c0b..cec2549a8 100644 --- a/man/html/git-rebase-update.html +++ b/man/html/git-rebase-update.html @@ -931,7 +931,7 @@ file.

[alias]
-  git reup = rebase-update
+ reup = rebase-update
@@ -956,7 +956,7 @@ by checking out the
diff --git a/man/html/git-reparent-branch.html b/man/html/git-reparent-branch.html index a448aeeb9..6ffe7ddc7 100644 --- a/man/html/git-reparent-branch.html +++ b/man/html/git-reparent-branch.html @@ -818,7 +818,7 @@ file.

[alias]
-  git rp = reparent-branch
+ rp = reparent-branch
@@ -842,7 +842,7 @@ by checking out the
diff --git a/man/html/git-squash-branch.html b/man/html/git-squash-branch.html index 367dfcb33..f55e907c8 100644 --- a/man/html/git-squash-branch.html +++ b/man/html/git-squash-branch.html @@ -854,7 +854,7 @@ file.

[alias]
-  git squash = squash-branch
+ squash = squash-branch
@@ -877,7 +877,7 @@ by checking out the
diff --git a/man/html/git-upstream-diff.html b/man/html/git-upstream-diff.html index ba0e9901e..a4049b731 100644 --- a/man/html/git-upstream-diff.html +++ b/man/html/git-upstream-diff.html @@ -895,7 +895,7 @@ file.

[alias]
-  git udiff = upstream-diff
+ udiff = upstream-diff
@@ -918,7 +918,7 @@ by checking out the
diff --git a/man/man1/git-map-branches.1 b/man/man1/git-map-branches.1 index 06bd2e7df..c90fad336 100644 --- 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 -.\" 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 diff --git a/man/man1/git-nav-downstream.1 b/man/man1/git-nav-downstream.1 index 271db2db3..cef3ad518 100644 --- 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 -.\" 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 diff --git a/man/man1/git-nav-upstream.1 b/man/man1/git-nav-upstream.1 index 772024d72..2b9a7e444 100644 --- 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 -.\" 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 diff --git a/man/man1/git-new-branch.1 b/man/man1/git-new-branch.1 index 63a1f9c22..9887e49fc 100644 --- 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 -.\" 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 diff --git a/man/man1/git-rebase-update.1 b/man/man1/git-rebase-update.1 index 6d56bd16d..fa39a6b59 100644 --- 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 -.\" 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 diff --git a/man/man1/git-reparent-branch.1 b/man/man1/git-reparent-branch.1 index 6019ea7b4..59e591e32 100644 --- 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 -.\" 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 diff --git a/man/man1/git-squash-branch.1 b/man/man1/git-squash-branch.1 index 355ce4e05..4bfcd7917 100644 --- 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 -.\" 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 diff --git a/man/man1/git-upstream-diff.1 b/man/man1/git-upstream-diff.1 index 1e27db48a..4cdd8be41 100644 --- 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 -.\" 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 diff --git a/man/src/git-map-branches.txt b/man/src/git-map-branches.txt index ee328a1c9..195fa828f 100644 --- 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 diff --git a/man/src/git-nav-downstream.txt b/man/src/git-nav-downstream.txt index 725017eb8..4984fbbe5 100644 --- 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 ---- diff --git a/man/src/git-nav-upstream.txt b/man/src/git-nav-upstream.txt index 5213bc102..a9ec03d65 100644 --- 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 diff --git a/man/src/git-new-branch.txt b/man/src/git-new-branch.txt index 0f761e2d3..9dc8d9459 100644 --- 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" diff --git a/man/src/git-rebase-update.txt b/man/src/git-rebase-update.txt index 07dc5e734..e7c0c2d2f 100644 --- 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 ---- diff --git a/man/src/git-reparent-branch.txt b/man/src/git-reparent-branch.txt index eb67d0674..5932b1190 100644 --- 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 diff --git a/man/src/git-squash-branch.txt b/man/src/git-squash-branch.txt index ef4e934c0..13d0155e7 100644 --- 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 ---- diff --git a/man/src/git-upstream-diff.txt b/man/src/git-upstream-diff.txt index 3646fd313..87695273d 100644 --- 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