Skip to content

Commit 679d0c0

Browse files
stephenfinstephenfin
committed
Store manpages in version control
Yes, it's not good practice to store auto-generated stuff in version control, but by doing this you avoid the need to install dependencies and packaging becomes much easier. Signed-off-by: Stephen Finucane <stephen@that.guru>
1 parent 5f3ce3f commit 679d0c0

18 files changed

+412
-3
lines changed

‎.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,6 @@ releasenotes/notes/reno.cache
7171
# virtualenv
7272
/.venv
7373

74-
# man pages
75-
/man
76-
7774
# Mypy
7875
/.mypy_cache
7976

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.TH "GIT-PW BUNDLE APPLY" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw bundle apply Manual"
2+
.SH NAME
3+
git-pw\-bundle\-apply \- Apply bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle apply
6+
[OPTIONS] BUNDLE_ID [ARGS]...
7+
.SH DESCRIPTION
8+
Apply bundle.
9+
.PP
10+
Apply a bundle locally using the 'git-am' command. Any additional ARGS
11+
provided will be passed to the 'git-am' command.

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.TH "GIT-PW BUNDLE DOWNLOAD" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw bundle download Manual"
2+
.SH NAME
3+
git-pw\-bundle\-download \- Download bundle in mbox format.
4+
.SH SYNOPSIS
5+
.B git-pw bundle download
6+
[OPTIONS] BUNDLE_ID [OUTPUT]
7+
.SH DESCRIPTION
8+
Download bundle in mbox format.
9+
.PP
10+
Download a bundle but do not apply it. ``OUTPUT`` is optional and can be an
11+
output path or ``-`` to output to ``stdout``. If ``OUTPUT`` is not
12+
provided, the output path will be automatically chosen.

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.TH "GIT-PW BUNDLE LIST" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw bundle list Manual"
2+
.SH NAME
3+
git-pw\-bundle\-list \- List bundles.
4+
.SH SYNOPSIS
5+
.B git-pw bundle list
6+
[OPTIONS] [NAME]
7+
.SH DESCRIPTION
8+
List bundles.
9+
.PP
10+
List bundles on the Patchwork instance.
11+
.SH OPTIONS
12+
.TP
13+
\fB\-\-owner\fP OWNER
14+
Show only bundles with these owners. Should be an email, name or ID. Private bundles of other users will not be shown.
15+
.TP
16+
\fB\-\-sort\fP FIELD
17+
Sort output on given field.
18+
.TP
19+
\fB\-\-page\fP PAGE
20+
Page to retrieve items from. This is influenced by the size of LIMIT.
21+
.TP
22+
\fB\-\-limit\fP LIMIT
23+
Maximum number of items to show.
24+
.TP
25+
\fB\-c,\fP \-\-column COLUMN
26+
Columns to be included in output.
27+
.TP
28+
\fB\-f,\fP \-\-format [simple|table|csv]
29+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.TH "GIT-PW BUNDLE SHOW" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw bundle show Manual"
2+
.SH NAME
3+
git-pw\-bundle\-show \- Show information about bundle.
4+
.SH SYNOPSIS
5+
.B git-pw bundle show
6+
[OPTIONS] BUNDLE_ID
7+
.SH DESCRIPTION
8+
Show information about bundle.
9+
.PP
10+
Retrieve Patchwork metadata for a bundle.
11+
.SH OPTIONS
12+
.TP
13+
\fB\-f,\fP \-\-format [simple|table|csv]
14+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

‎man/git-pw-bundle.1

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.TH "GIT-PW BUNDLE" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw bundle Manual"
2+
.SH NAME
3+
git-pw\-bundle \- Interact with bundles.
4+
.SH SYNOPSIS
5+
.B git-pw bundle
6+
[OPTIONS] COMMAND [ARGS]...
7+
.SH DESCRIPTION
8+
Interact with bundles.
9+
.PP
10+
Bundles are custom, user-defined groups of patches. Bundles can be
11+
used to keep patch lists, preserving order, for future inclusion in
12+
a tree. There's no restriction of number of patches and they don't
13+
even need to be in the same project. A single patch also can be
14+
part of multiple bundles at the same time. An example of Bundle
15+
usage would be keeping track of the Patches that are ready for
16+
merge to the tree.
17+
.SH COMMANDS
18+
.PP
19+
\fBapply\fP
20+
Apply bundle.
21+
See \fBgit-pw bundle-apply(1)\fP for full documentation on the \fBapply\fP command.
22+
.PP
23+
\fBshow\fP
24+
Show information about bundle.
25+
See \fBgit-pw bundle-show(1)\fP for full documentation on the \fBshow\fP command.
26+
.PP
27+
\fBdownload\fP
28+
Download bundle in mbox format.
29+
See \fBgit-pw bundle-download(1)\fP for full documentation on the \fBdownload\fP command.
30+
.PP
31+
\fBlist\fP
32+
List bundles.
33+
See \fBgit-pw bundle-list(1)\fP for full documentation on the \fBlist\fP command.

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.TH "GIT-PW PATCH APPLY" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw patch apply Manual"
2+
.SH NAME
3+
git-pw\-patch\-apply \- Apply patch.
4+
.SH SYNOPSIS
5+
.B git-pw patch apply
6+
[OPTIONS] PATCH_ID [ARGS]...
7+
.SH DESCRIPTION
8+
Apply patch.
9+
.PP
10+
Apply a patch locally using the 'git-am' command. Any additional ARGS
11+
provided will be passed to the 'git-am' command.
12+
.SH OPTIONS
13+
.TP
14+
\fB\-\-series\fP SERIES
15+
Series to include dependencies from. Defaults to latest.
16+
.TP
17+
\fB\-\-deps\fP / \-\-no\-deps
18+
When applying the patch, include dependencies if available. Defaults to using the most recent series.

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.TH "GIT-PW PATCH DOWNLOAD" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw patch download Manual"
2+
.SH NAME
3+
git-pw\-patch\-download \- Download patch in diff or mbox format.
4+
.SH SYNOPSIS
5+
.B git-pw patch download
6+
[OPTIONS] PATCH_ID [OUTPUT]
7+
.SH DESCRIPTION
8+
Download patch in diff or mbox format.
9+
.PP
10+
Download a patch but do not apply it. ``OUTPUT`` is optional and can be an
11+
output path or ``-`` to output to ``stdout``. If ``OUTPUT`` is not
12+
provided, the output path will be automatically chosen.
13+
.SH OPTIONS
14+
.TP
15+
\fB\-\-diff\fP
16+
Show patch in diff format.
17+
.TP
18+
\fB\-\-mbox\fP
19+
Show patch in mbox format.

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.TH "GIT-PW PATCH LIST" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw patch list Manual"
2+
.SH NAME
3+
git-pw\-patch\-list \- List patches.
4+
.SH SYNOPSIS
5+
.B git-pw patch list
6+
[OPTIONS] [NAME]
7+
.SH DESCRIPTION
8+
List patches.
9+
.PP
10+
List patches on the Patchwork instance.
11+
.SH OPTIONS
12+
.TP
13+
\fB\-\-state\fP STATE
14+
Show only patches matching these states. Should be slugified representations of states. The available states are instance dependant.
15+
.TP
16+
\fB\-\-submitter\fP SUBMITTER
17+
Show only patches by these submitters. Should be an email, name or ID.
18+
.TP
19+
\fB\-\-delegate\fP DELEGATE
20+
Show only patches by these delegates. Should be an email or username.
21+
.TP
22+
\fB\-\-archived\fP
23+
Include patches that are archived.
24+
.TP
25+
\fB\-\-sort\fP FIELD
26+
Sort output on given field.
27+
.TP
28+
\fB\-\-page\fP PAGE
29+
Page to retrieve items from. This is influenced by the size of LIMIT.
30+
.TP
31+
\fB\-\-limit\fP LIMIT
32+
Maximum number of items to show.
33+
.TP
34+
\fB\-c,\fP \-\-column COLUMN
35+
Columns to be included in output.
36+
.TP
37+
\fB\-f,\fP \-\-format [simple|table|csv]
38+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.TH "GIT-PW PATCH SHOW" "1" "13-Sep-2019" "1.6.1.dev6" "git-pw patch show Manual"
2+
.SH NAME
3+
git-pw\-patch\-show \- Show information about patch.
4+
.SH SYNOPSIS
5+
.B git-pw patch show
6+
[OPTIONS] PATCH_ID
7+
.SH DESCRIPTION
8+
Show information about patch.
9+
.PP
10+
Retrieve Patchwork metadata for a patch.
11+
.SH OPTIONS
12+
.TP
13+
\fB\-f,\fP \-\-format [simple|table|csv]
14+
Output format. Defaults to the value of 'git config pw.format' else 'table'.

0 commit comments

Comments
 (0)