Skip to content

Commit 50be9dd

Browse files
stephenfinstephenfin
committed
man: Update man pages to reflect latest changes
We have two new commands: 'bundle create' and 'bundle update'. Signed-off-by: Stephen Finucane <stephen@that.guru>
1 parent dd84a07 commit 50be9dd

22 files changed

+131
-17
lines changed

‎man/git-pw-bundle-add.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.TH "GIT-PW BUNDLE ADD" "1" "2020-04-17" "1.9.0" "git-pw bundle add Manual"
2+
.SH NAME
3+
git-pw\-bundle\-add \- Add one or more patches to a bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle add
6+
[OPTIONS] BUNDLE_ID PATCH_IDS...
7+
.SH DESCRIPTION
8+
Add one or more patches to a bundle.
9+
.PP
10+
Append the provided PATCH_IDS to bundle BUNDLE_ID.
11+
.PP
12+
Requires API version 1.2 or greater.
13+
.SH OPTIONS
14+
.TP
15+
\fB\-f,\fP \-\-format [simple|table|csv]
16+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

‎man/git-pw-bundle-apply.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "GIT-PW BUNDLE APPLY" "1" "08-Dec-2019" "1.8.0" "git-pw bundle apply Manual"
1+
.TH "GIT-PW BUNDLE APPLY" "1" "2020-04-17" "1.9.0" "git-pw bundle apply Manual"
22
.SH NAME
33
git-pw\-bundle\-apply \- Apply bundle.
44
.SH SYNOPSIS

‎man/git-pw-bundle-create.1

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.TH "GIT-PW BUNDLE CREATE" "1" "2020-04-17" "1.9.0" "git-pw bundle create Manual"
2+
.SH NAME
3+
git-pw\-bundle\-create \- Create a bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle create
6+
[OPTIONS] NAME PATCH_IDS...
7+
.SH DESCRIPTION
8+
Create a bundle.
9+
.PP
10+
Create a bundle with the given NAME and patches from PATCH_ID.
11+
.PP
12+
Requires API version 1.2 or greater.
13+
.SH OPTIONS
14+
.TP
15+
\fB\-\-public\fP / \-\-private
16+
Allow other users to view this bundle. If private, only you will be able to see this bundle.
17+
.TP
18+
\fB\-f,\fP \-\-format [simple|table|csv]
19+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

‎man/git-pw-bundle-delete.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.TH "GIT-PW BUNDLE DELETE" "1" "2020-04-17" "1.9.0" "git-pw bundle delete Manual"
2+
.SH NAME
3+
git-pw\-bundle\-delete \- Delete a bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle delete
6+
[OPTIONS] BUNDLE_ID
7+
.SH DESCRIPTION
8+
Delete a bundle.
9+
.PP
10+
Delete bundle BUNDLE_ID.
11+
.PP
12+
Requires API version 1.2 or greater.
13+
.SH OPTIONS
14+
.TP
15+
\fB\-f,\fP \-\-format [simple|table|csv]
16+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

‎man/git-pw-bundle-download.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "GIT-PW BUNDLE DOWNLOAD" "1" "08-Dec-2019" "1.8.0" "git-pw bundle download Manual"
1+
.TH "GIT-PW BUNDLE DOWNLOAD" "1" "2020-04-17" "1.9.0" "git-pw bundle download Manual"
22
.SH NAME
33
git-pw\-bundle\-download \- Download bundle in mbox format.
44
.SH SYNOPSIS

‎man/git-pw-bundle-list.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "GIT-PW BUNDLE LIST" "1" "08-Dec-2019" "1.8.0" "git-pw bundle list Manual"
1+
.TH "GIT-PW BUNDLE LIST" "1" "2020-04-17" "1.9.0" "git-pw bundle list Manual"
22
.SH NAME
33
git-pw\-bundle\-list \- List bundles.
44
.SH SYNOPSIS

‎man/git-pw-bundle-remove.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.TH "GIT-PW BUNDLE REMOVE" "1" "2020-04-17" "1.9.0" "git-pw bundle remove Manual"
2+
.SH NAME
3+
git-pw\-bundle\-remove \- Remove one or more patches from a bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle remove
6+
[OPTIONS] BUNDLE_ID PATCH_IDS...
7+
.SH DESCRIPTION
8+
Remove one or more patches from a bundle.
9+
.PP
10+
Remove the provided PATCH_IDS to bundle BUNDLE_ID.
11+
.PP
12+
Requires API version 1.2 or greater.
13+
.SH OPTIONS
14+
.TP
15+
\fB\-f,\fP \-\-format [simple|table|csv]
16+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

‎man/git-pw-bundle-show.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "GIT-PW BUNDLE SHOW" "1" "08-Dec-2019" "1.8.0" "git-pw bundle show Manual"
1+
.TH "GIT-PW BUNDLE SHOW" "1" "2020-04-17" "1.9.0" "git-pw bundle show Manual"
22
.SH NAME
33
git-pw\-bundle\-show \- Show information about bundle.
44
.SH SYNOPSIS

‎man/git-pw-bundle-update.1

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.TH "GIT-PW BUNDLE UPDATE" "1" "2020-04-17" "1.9.0" "git-pw bundle update Manual"
2+
.SH NAME
3+
git-pw\-bundle\-update \- Update a bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle update
6+
[OPTIONS] BUNDLE_ID
7+
.SH DESCRIPTION
8+
Update a bundle.
9+
.PP
10+
Update bundle BUNDLE_ID. If PATCH_IDs are specified, this will overwrite
11+
all patches in the bundle. Use 'bundle add' and 'bundle remove' to add or
12+
remove patches.
13+
.PP
14+
Requires API version 1.2 or greater.
15+
.SH OPTIONS
16+
.TP
17+
\fB\-\-name\fP TEXT
18+
.PP
19+
.TP
20+
\fB\-\-patch\fP INTEGER
21+
Add the specified patch(es) to the bundle.
22+
.TP
23+
\fB\-\-public\fP / \-\-private
24+
Allow other users to view this bundle. If private, only you will be able to see this bundle.
25+
.TP
26+
\fB\-f,\fP \-\-format [simple|table|csv]
27+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

‎man/git-pw-bundle.1

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "GIT-PW BUNDLE" "1" "08-Dec-2019" "1.8.0" "git-pw bundle Manual"
1+
.TH "GIT-PW BUNDLE" "1" "2020-04-17" "1.9.0" "git-pw bundle Manual"
22
.SH NAME
33
git-pw\-bundle \- Interact with bundles.
44
.SH SYNOPSIS
@@ -31,3 +31,23 @@ merge to the tree.
3131
\fBlist\fP
3232
List bundles.
3333
See \fBgit-pw bundle-list(1)\fP for full documentation on the \fBlist\fP command.
34+
.PP
35+
\fBcreate\fP
36+
Create a bundle.
37+
See \fBgit-pw bundle-create(1)\fP for full documentation on the \fBcreate\fP command.
38+
.PP
39+
\fBupdate\fP
40+
Update a bundle.
41+
See \fBgit-pw bundle-update(1)\fP for full documentation on the \fBupdate\fP command.
42+
.PP
43+
\fBdelete\fP
44+
Delete a bundle.
45+
See \fBgit-pw bundle-delete(1)\fP for full documentation on the \fBdelete\fP command.
46+
.PP
47+
\fBadd\fP
48+
Add one or more patches to a bundle.
49+
See \fBgit-pw bundle-add(1)\fP for full documentation on the \fBadd\fP command.
50+
.PP
51+
\fBremove\fP
52+
Remove one or more patches from a bundle.
53+
See \fBgit-pw bundle-remove(1)\fP for full documentation on the \fBremove\fP command.

0 commit comments

Comments
 (0)