summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Shadura <andrew.shadura@collabora.co.uk>2016-10-20 13:32:28 +0200
committerThibault Saunier <thibault.saunier@osg.samsung.com>2016-11-14 08:58:59 -0300
commit3fba85f01954fad7edee63637562e3721fc1ebaa (patch)
treeff79acd67f9f2c824c2f013302e51da252e4f404
parent8a2cac12e2c1805e05c45a52d72beb8b25b7e0df (diff)
git-phab.txt: Make the formatting more manpagey.
Apply formatting traditionally used in manpages: commands in bold, metavariables in italic, code samples in monospace. Signed-off-by: Andrew Shadura <andrew.shadura@collabora.co.uk> Differential Revision: https://phabricator.freedesktop.org/D1395
-rw-r--r--git-phab.txt71
1 files changed, 36 insertions, 35 deletions
diff --git a/git-phab.txt b/git-phab.txt
index 5c5bd52..0247776 100644
--- a/git-phab.txt
+++ b/git-phab.txt
@@ -8,17 +8,17 @@ git-phab - Git subcommand to integrate with phabricator.
8SYNOPSIS 8SYNOPSIS
9-------- 9--------
10[verse] 10[verse]
11'git phab attach' [-h] [--reviewers <username1,#project2,...>] 11*git phab attach* [-h] [--reviewers '<username1,#project2,...>']
12 [--cc <username1,#project2,...>] [--message <message>] 12 [--cc '<username1,#project2,...>'] [--message '<message>']
13 [--task <T123>] [--remote <remote>] [--assume-yes] 13 [--task '<T123>'] [--remote <remote>] [--assume-yes]
14 [--projects <project1,project2,...>] 14 [--projects '<project1,project2,...>']
15 [<revision range>] 15 ['<revision range>']
16'git phab log' [-h] [<revision range>] 16*git phab log* [-h] [<revision range>]
17'git phab fetch' [-h] [<T123>] 17*git phab fetch* [-h] ['<T123>']
18'git phab checkout' [-h] [<T123>] 18*git phab checkout* [-h] ['<T123>']
19'git phab browse' [-h] [objects [objects ...]] 19*git phab browse* [-h] ['objects' ['objects' ...]]
20'git phab clean' [-h] 20*git phab clean* [-h]
21'git phab land' [-h] [--no-push] 21*git phab land* [-h] [--no-push]
22 22
23DESCRIPTION 23DESCRIPTION
24----------- 24-----------
@@ -27,21 +27,21 @@ Provides integration for projects using Phabricator.
27 27
28The current repository must contain a valid `.arcconfig` file and a remote 28The current repository must contain a valid `.arcconfig` file and a remote
29location to push submitted branches must be defined using: 29location to push submitted branches must be defined using:
30[verse] 30
31git config phab.remote <remote> 31 git config phab.remote <remote>
32 32
33COMMANDS 33COMMANDS
34-------- 34--------
35 35
36'attach':: 36*attach*::
37 37
38Creates a new differential for each commit in the provided <revision_range>. 38Creates a new differential for each commit in the provided '<revision_range>'.
39Commit messages will be rewritten to include the URL of the newly created 39Commit messages will be rewritten to include the URL of the newly created
40Differential (no other information will be added to the message). If a commit 40Differential (no other information will be added to the message). If a commit
41message already contains the URL of a Differential it will be updated instead of 41message already contains the URL of a Differential it will be updated instead of
42creating a new one. 42creating a new one.
43+ 43+
44<revision_range> can be either a range of commits or a single commit, as 44'<revision_range>' can be either a range of commits or a single commit, as
45understood by `git rev-parse`. If omitted, the default range is from the remote 45understood by `git rev-parse`. If omitted, the default range is from the remote
46current branch's remote tracking commit to HEAD. 46current branch's remote tracking commit to HEAD.
47+ 47+
@@ -57,32 +57,33 @@ If a task is defined but the current branch is not in the form
57`Txxx-description`, it will prompt if a new branch must be created using current 57`Txxx-description`, it will prompt if a new branch must be created using current
58branch's name prefixed with `Txxx-`. 58branch's name prefixed with `Txxx-`.
59 59
60'log':: 60*log*::
61 61
62Prints all commits in the provided <revision_range>. For each commit it displays 62Prints all commits in the provided <revision_range>. For each commit it displays
63the Differential ID and its current status. See the 'attach' command for details 63the Differential ID and its current status. See the 'attach' command for details
64on how <revision_range> is formed. 64on how '<revision_range>' is formed.
65 65
66'fetch':: 66*fetch*::
67 67
68Fetch the branch linked to a Maniphest task. With no argument the task will be 68Fetch the branch linked to a Maniphest task. With no argument the task will be
69defined from the current branch name, if it is in the form `Txxx-description`. 69defined from the current branch name, if it is in the form `Txxx-description`.
70+ 70+
71This only fetch and print the commit id, it won't create or checkout a branch. 71This only fetch and print the commit id, it won't create or checkout a branch.
72A new branch can then be created using, for example: 72A new branch can then be created using, for example:
73[verse]
74git checkout -b my-branch FETCH_HEAD
75See also 'checkout' command.
76 73
77'checkout':: 74 git checkout -b my-branch FETCH_HEAD
75
76See also *checkout* command.
77
78*checkout*::
78 79
79Same as 'fetch' but also create a new branch and check it out. If an existing 80Same as *fetch* but also create a new branch and check it out. If an existing
80branch is found for the same task it will prompt to reset that branch to the 81branch is found for the same task it will prompt to reset that branch to the
81newly fetched commit, then checkout is as well. 82newly fetched commit, then checkout is as well.
82 83
83'browse':: 84*browse*::
84 85
85Open related URIs in a web browser using 'xdg-open'. 86Open related URIs in a web browser using *xdg-open*.
86+ 87+
87With no argument, if the current branch is in the form `Txxx-description`, opens 88With no argument, if the current branch is in the form `Txxx-description`, opens
88that Maniphest task. 89that Maniphest task.
@@ -92,19 +93,19 @@ Differential/Maniphest. Otherwise it is assumed that object is a commit as
92understood by `git rev-parse` and if that commit contains a link to a 93understood by `git rev-parse` and if that commit contains a link to a
93Differential it will be open. 94Differential it will be open.
94 95
95'clean':: 96*clean*::
96 97
97For all local and remote references, if they are in the form `Txxx-description` 98For all local and remote references, if they are in the form `Txxx-description`
98and the corresponding task has been closed, prompt if that branch should be 99and the corresponding task has been closed, prompt if that branch should be
99removed. 100removed.
100 101
101'land':: 102*land*::
102 103
103Same as `git push` but for each commit that would be pushed, query who approved 104Same as `git push` but for each commit that would be pushed, query who approved
104its differential and add corresponding 'Reviewed-by:' line. Note that the email 105its differential and add corresponding 'Reviewed-by:' line. Note that the email
105address is guessed by looking the reviewer's fullname into `git shortlog`. If 106address is guessed by looking the reviewer's fullname into `git shortlog`. If
106the fullname cannot be found it will be asked then stored into 107the fullname cannot be found it will be asked then stored into
107~/.config/git/phab so it won't be prompted again. 108`~/.config/git/phab` so it won't be prompted again.
108+ 109+
109For each related tasks, also prompt if it should be closed. 110For each related tasks, also prompt if it should be closed.
110 111
@@ -112,26 +113,26 @@ Examples
112-------- 113--------
113 114
114Attach all commits since origin/master 115Attach all commits since origin/master
115[verse] 116
116 $ git phab attach 117 $ git phab attach
117 118
118Attach only the top commit 119Attach only the top commit
119[verse] 120
120 $ git phab attach HEAD 121 $ git phab attach HEAD
121 122
122Attach all commits since origin/master, excluding top commit 123Attach all commits since origin/master, excluding top commit
123[verse] 124
124 $ git phab attach origin/master..HEAD^ 125 $ git phab attach origin/master..HEAD^
125 126
126Attach top 3 patches, link them to a task, and set reviewers 127Attach top 3 patches, link them to a task, and set reviewers
127[verse] 128
128 $ git phab attach --reviewers xclaesse,smcv --task T123 HEAD~3.. 129 $ git phab attach --reviewers xclaesse,smcv --task T123 HEAD~3..
129 130
130Push current branch to origin/wip/phab/T123 131Push current branch to origin/wip/phab/T123
131[verse] 132
132 $ git config phab.remote origin 133 $ git config phab.remote origin
133 $ git phab attach --task T123 134 $ git phab attach --task T123
134 135
135Fetch a branch associated with the task T123 136Fetch a branch associated with the task T123
136[verse] 137
137 $ git phab fetch T123 138 $ git phab fetch T123