Skip to content

Commit

Permalink
Release 2.4.0
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Finucane <stephen@that.guru>
  • Loading branch information
stephenfin committed Dec 6, 2022
1 parent cf80c6e commit 999a802
Show file tree
Hide file tree
Showing 22 changed files with 110 additions and 91 deletions.
7 changes: 4 additions & 3 deletions man/git-pw-bundle-add.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE ADD" "1" "2022-03-24" "2.3.0" "git-pw bundle add Manual"
.TH "GIT-PW BUNDLE ADD" "1" "2022-12-06" "2.4.0" "git-pw bundle add Manual"
.SH NAME
git-pw\-bundle\-add \- Add one or more patches to a bundle.
.SH SYNOPSIS
Expand All @@ -7,9 +7,10 @@ git-pw\-bundle\-add \- Add one or more patches to a bundle.
.SH DESCRIPTION
Add one or more patches to a bundle.
.PP
Append the provided PATCH_IDS to bundle BUNDLE_ID.
Append the provided PATCH_IDS to bundle BUNDLE_ID.
.PP
Requires API version 1.2 or greater.
Requires API version 1.2 or greater.

.SH OPTIONS
.TP
\fB\-f,\fP \-\-format [simple|table|csv|yaml]
Expand Down
6 changes: 3 additions & 3 deletions man/git-pw-bundle-apply.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE APPLY" "1" "2022-03-24" "2.3.0" "git-pw bundle apply Manual"
.TH "GIT-PW BUNDLE APPLY" "1" "2022-12-06" "2.4.0" "git-pw bundle apply Manual"
.SH NAME
git-pw\-bundle\-apply \- Apply bundle.
.SH SYNOPSIS
Expand All @@ -7,5 +7,5 @@ git-pw\-bundle\-apply \- Apply bundle.
.SH DESCRIPTION
Apply bundle.
.PP
Apply a bundle locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.
Apply a bundle locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.
7 changes: 4 additions & 3 deletions man/git-pw-bundle-create.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE CREATE" "1" "2022-03-24" "2.3.0" "git-pw bundle create Manual"
.TH "GIT-PW BUNDLE CREATE" "1" "2022-12-06" "2.4.0" "git-pw bundle create Manual"
.SH NAME
git-pw\-bundle\-create \- Create a bundle.
.SH SYNOPSIS
Expand All @@ -7,9 +7,10 @@ git-pw\-bundle\-create \- Create a bundle.
.SH DESCRIPTION
Create a bundle.
.PP
Create a bundle with the given NAME and patches from PATCH_ID.
Create a bundle with the given NAME and patches from PATCH_ID.
.PP
Requires API version 1.2 or greater.
Requires API version 1.2 or greater.

.SH OPTIONS
.TP
\fB\-\-public\fP / \-\-private
Expand Down
7 changes: 4 additions & 3 deletions man/git-pw-bundle-delete.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE DELETE" "1" "2022-03-24" "2.3.0" "git-pw bundle delete Manual"
.TH "GIT-PW BUNDLE DELETE" "1" "2022-12-06" "2.4.0" "git-pw bundle delete Manual"
.SH NAME
git-pw\-bundle\-delete \- Delete a bundle.
.SH SYNOPSIS
Expand All @@ -7,9 +7,10 @@ git-pw\-bundle\-delete \- Delete a bundle.
.SH DESCRIPTION
Delete a bundle.
.PP
Delete bundle BUNDLE_ID.
Delete bundle BUNDLE_ID.
.PP
Requires API version 1.2 or greater.
Requires API version 1.2 or greater.

.SH OPTIONS
.TP
\fB\-f,\fP \-\-format [simple|table|csv|yaml]
Expand Down
8 changes: 4 additions & 4 deletions man/git-pw-bundle-download.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE DOWNLOAD" "1" "2022-03-24" "2.3.0" "git-pw bundle download Manual"
.TH "GIT-PW BUNDLE DOWNLOAD" "1" "2022-12-06" "2.4.0" "git-pw bundle download Manual"
.SH NAME
git-pw\-bundle\-download \- Download bundle in mbox format.
.SH SYNOPSIS
Expand All @@ -7,6 +7,6 @@ git-pw\-bundle\-download \- Download bundle in mbox format.
.SH DESCRIPTION
Download bundle in mbox format.
.PP
Download a bundle but do not apply it. ``OUTPUT`` is optional and can be an
output full file path or a directory or ``-`` to output to ``stdout``. If
``OUTPUT`` is not provided, the output path will be automatically chosen.
Download a bundle but do not apply it. ``OUTPUT`` is optional and can be an
output full file path or a directory or ``-`` to output to ``stdout``. If
``OUTPUT`` is not provided, the output path will be automatically chosen.
5 changes: 3 additions & 2 deletions man/git-pw-bundle-list.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE LIST" "1" "2022-03-24" "2.3.0" "git-pw bundle list Manual"
.TH "GIT-PW BUNDLE LIST" "1" "2022-12-06" "2.4.0" "git-pw bundle list Manual"
.SH NAME
git-pw\-bundle\-list \- List bundles.
.SH SYNOPSIS
Expand All @@ -7,7 +7,8 @@ git-pw\-bundle\-list \- List bundles.
.SH DESCRIPTION
List bundles.
.PP
List bundles on the Patchwork instance.
List bundles on the Patchwork instance.

.SH OPTIONS
.TP
\fB\-\-owner\fP OWNER
Expand Down
7 changes: 4 additions & 3 deletions man/git-pw-bundle-remove.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE REMOVE" "1" "2022-03-24" "2.3.0" "git-pw bundle remove Manual"
.TH "GIT-PW BUNDLE REMOVE" "1" "2022-12-06" "2.4.0" "git-pw bundle remove Manual"
.SH NAME
git-pw\-bundle\-remove \- Remove one or more patches from a bundle.
.SH SYNOPSIS
Expand All @@ -7,9 +7,10 @@ git-pw\-bundle\-remove \- Remove one or more patches from a bundle.
.SH DESCRIPTION
Remove one or more patches from a bundle.
.PP
Remove the provided PATCH_IDS to bundle BUNDLE_ID.
Remove the provided PATCH_IDS to bundle BUNDLE_ID.
.PP
Requires API version 1.2 or greater.
Requires API version 1.2 or greater.

.SH OPTIONS
.TP
\fB\-f,\fP \-\-format [simple|table|csv|yaml]
Expand Down
5 changes: 3 additions & 2 deletions man/git-pw-bundle-show.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE SHOW" "1" "2022-03-24" "2.3.0" "git-pw bundle show Manual"
.TH "GIT-PW BUNDLE SHOW" "1" "2022-12-06" "2.4.0" "git-pw bundle show Manual"
.SH NAME
git-pw\-bundle\-show \- Show information about bundle.
.SH SYNOPSIS
Expand All @@ -7,7 +7,8 @@ git-pw\-bundle\-show \- Show information about bundle.
.SH DESCRIPTION
Show information about bundle.
.PP
Retrieve Patchwork metadata for a bundle.
Retrieve Patchwork metadata for a bundle.

.SH OPTIONS
.TP
\fB\-f,\fP \-\-format [simple|table|csv|yaml]
Expand Down
11 changes: 6 additions & 5 deletions man/git-pw-bundle-update.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE UPDATE" "1" "2022-03-24" "2.3.0" "git-pw bundle update Manual"
.TH "GIT-PW BUNDLE UPDATE" "1" "2022-12-06" "2.4.0" "git-pw bundle update Manual"
.SH NAME
git-pw\-bundle\-update \- Update a bundle.
.SH SYNOPSIS
Expand All @@ -7,11 +7,12 @@ git-pw\-bundle\-update \- Update a bundle.
.SH DESCRIPTION
Update a bundle.
.PP
Update bundle BUNDLE_ID. If PATCH_IDs are specified, this will overwrite
all patches in the bundle. Use 'bundle add' and 'bundle remove' to add or
remove patches.
Update bundle BUNDLE_ID. If PATCH_IDs are specified, this will overwrite
all patches in the bundle. Use 'bundle add' and 'bundle remove' to add or
remove patches.
.PP
Requires API version 1.2 or greater.
Requires API version 1.2 or greater.

.SH OPTIONS
.TP
\fB\-\-name\fP TEXT
Expand Down
17 changes: 9 additions & 8 deletions man/git-pw-bundle.1
@@ -1,4 +1,4 @@
.TH "GIT-PW BUNDLE" "1" "2022-03-24" "2.3.0" "git-pw bundle Manual"
.TH "GIT-PW BUNDLE" "1" "2022-12-06" "2.4.0" "git-pw bundle Manual"
.SH NAME
git-pw\-bundle \- Interact with bundles.
.SH SYNOPSIS
Expand All @@ -7,13 +7,14 @@ git-pw\-bundle \- Interact with bundles.
.SH DESCRIPTION
Interact with bundles.
.PP
Bundles are custom, user-defined groups of patches. Bundles can be
used to keep patch lists, preserving order, for future inclusion in
a tree. There's no restriction of number of patches and they don't
even need to be in the same project. A single patch also can be
part of multiple bundles at the same time. An example of Bundle
usage would be keeping track of the Patches that are ready for
merge to the tree.
Bundles are custom, user-defined groups of patches. Bundles can be
used to keep patch lists, preserving order, for future inclusion in
a tree. There's no restriction of number of patches and they don't
even need to be in the same project. A single patch also can be
part of multiple bundles at the same time. An example of Bundle
usage would be keeping track of the Patches that are ready for
merge to the tree.

.SH COMMANDS
.PP
\fBapply\fP
Expand Down
9 changes: 5 additions & 4 deletions man/git-pw-patch-apply.1
@@ -1,4 +1,4 @@
.TH "GIT-PW PATCH APPLY" "1" "2022-03-24" "2.3.0" "git-pw patch apply Manual"
.TH "GIT-PW PATCH APPLY" "1" "2022-12-06" "2.4.0" "git-pw patch apply Manual"
.SH NAME
git-pw\-patch\-apply \- Apply patch.
.SH SYNOPSIS
Expand All @@ -7,12 +7,13 @@ git-pw\-patch\-apply \- Apply patch.
.SH DESCRIPTION
Apply patch.
.PP
Apply a patch locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.
Apply a patch locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.

.SH OPTIONS
.TP
\fB\-\-series\fP SERIES
Series to include dependencies from. Defaults to latest.
.TP
\fB\-\-deps\fP / \-\-no\-deps
When applying the patch, include dependencies if available. Defaults to using the most recent series.
When applying the patch, include series dependencies if available. Dependencies are retrieved from the most recent series by default. Defaults to the value of 'git config pw applyPatchDeps' else 'true'.
9 changes: 5 additions & 4 deletions man/git-pw-patch-download.1
@@ -1,4 +1,4 @@
.TH "GIT-PW PATCH DOWNLOAD" "1" "2022-03-24" "2.3.0" "git-pw patch download Manual"
.TH "GIT-PW PATCH DOWNLOAD" "1" "2022-12-06" "2.4.0" "git-pw patch download Manual"
.SH NAME
git-pw\-patch\-download \- Download patch in diff or mbox format.
.SH SYNOPSIS
Expand All @@ -7,9 +7,10 @@ git-pw\-patch\-download \- Download patch in diff or mbox format.
.SH DESCRIPTION
Download patch in diff or mbox format.
.PP
Download a patch but do not apply it. ``OUTPUT`` is optional and can be an
output file path or a directory or ``-`` to output to ``stdout``. If
``OUTPUT`` is not provided, the output path will be automatically chosen.
Download a patch but do not apply it. ``OUTPUT`` is optional and can be an
output file path or a directory or ``-`` to output to ``stdout``. If
``OUTPUT`` is not provided, the output path will be automatically chosen.

.SH OPTIONS
.TP
\fB\-\-diff\fP
Expand Down
5 changes: 3 additions & 2 deletions man/git-pw-patch-list.1
@@ -1,4 +1,4 @@
.TH "GIT-PW PATCH LIST" "1" "2022-03-24" "2.3.0" "git-pw patch list Manual"
.TH "GIT-PW PATCH LIST" "1" "2022-12-06" "2.4.0" "git-pw patch list Manual"
.SH NAME
git-pw\-patch\-list \- List patches.
.SH SYNOPSIS
Expand All @@ -7,7 +7,8 @@ git-pw\-patch\-list \- List patches.
.SH DESCRIPTION
List patches.
.PP
List patches on the Patchwork instance.
List patches on the Patchwork instance.

.SH OPTIONS
.TP
\fB\-\-state\fP STATE
Expand Down
5 changes: 3 additions & 2 deletions man/git-pw-patch-show.1
@@ -1,4 +1,4 @@
.TH "GIT-PW PATCH SHOW" "1" "2022-03-24" "2.3.0" "git-pw patch show Manual"
.TH "GIT-PW PATCH SHOW" "1" "2022-12-06" "2.4.0" "git-pw patch show Manual"
.SH NAME
git-pw\-patch\-show \- Show information about patch.
.SH SYNOPSIS
Expand All @@ -7,7 +7,8 @@ git-pw\-patch\-show \- Show information about patch.
.SH DESCRIPTION
Show information about patch.
.PP
Retrieve Patchwork metadata for a patch.
Retrieve Patchwork metadata for a patch.

.SH OPTIONS
.TP
\fB\-f,\fP \-\-format [simple|table|csv|yaml]
Expand Down
7 changes: 4 additions & 3 deletions man/git-pw-patch-update.1
@@ -1,4 +1,4 @@
.TH "GIT-PW PATCH UPDATE" "1" "2022-03-24" "2.3.0" "git-pw patch update Manual"
.TH "GIT-PW PATCH UPDATE" "1" "2022-12-06" "2.4.0" "git-pw patch update Manual"
.SH NAME
git-pw\-patch\-update \- Update one or more patches.
.SH SYNOPSIS
Expand All @@ -7,8 +7,9 @@ git-pw\-patch\-update \- Update one or more patches.
.SH DESCRIPTION
Update one or more patches.
.PP
Updates one or more Patches on the Patchwork instance. Some operations may
require admin or maintainer permissions.
Updates one or more Patches on the Patchwork instance. Some operations may
require admin or maintainer permissions.

.SH OPTIONS
.TP
\fB\-\-commit\-ref\fP COMMIT_REF
Expand Down
15 changes: 8 additions & 7 deletions man/git-pw-patch.1
@@ -1,4 +1,4 @@
.TH "GIT-PW PATCH" "1" "2022-03-24" "2.3.0" "git-pw patch Manual"
.TH "GIT-PW PATCH" "1" "2022-12-06" "2.4.0" "git-pw patch Manual"
.SH NAME
git-pw\-patch \- Interact with patches.
.SH SYNOPSIS
Expand All @@ -7,12 +7,13 @@ git-pw\-patch \- Interact with patches.
.SH DESCRIPTION
Interact with patches.
.PP
Patches are the central object in Patchwork structure. A patch
contains both a diff and some metadata, such as the name, the
description, the author, the version of the patch etc. Patchwork
stores not only the patch itself but also various metadata
associated with the email that the patch was parsed from, such as
the message headers or the date the message itself was received.
Patches are the central object in Patchwork structure. A patch
contains both a diff and some metadata, such as the name, the
description, the author, the version of the patch etc. Patchwork
stores not only the patch itself but also various metadata
associated with the email that the patch was parsed from, such as
the message headers or the date the message itself was received.

.SH COMMANDS
.PP
\fBapply\fP
Expand Down
6 changes: 3 additions & 3 deletions man/git-pw-series-apply.1
@@ -1,4 +1,4 @@
.TH "GIT-PW SERIES APPLY" "1" "2022-03-24" "2.3.0" "git-pw series apply Manual"
.TH "GIT-PW SERIES APPLY" "1" "2022-12-06" "2.4.0" "git-pw series apply Manual"
.SH NAME
git-pw\-series\-apply \- Apply series.
.SH SYNOPSIS
Expand All @@ -7,5 +7,5 @@ git-pw\-series\-apply \- Apply series.
.SH DESCRIPTION
Apply series.
.PP
Apply a series locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.
Apply a series locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.
9 changes: 5 additions & 4 deletions man/git-pw-series-download.1
@@ -1,4 +1,4 @@
.TH "GIT-PW SERIES DOWNLOAD" "1" "2022-03-24" "2.3.0" "git-pw series download Manual"
.TH "GIT-PW SERIES DOWNLOAD" "1" "2022-12-06" "2.4.0" "git-pw series download Manual"
.SH NAME
git-pw\-series\-download \- Download series in mbox format.
.SH SYNOPSIS
Expand All @@ -7,9 +7,10 @@ git-pw\-series\-download \- Download series in mbox format.
.SH DESCRIPTION
Download series in mbox format.
.PP
Download a series but do not apply it. ``OUTPUT`` is optional and can be an
output path or ``-`` to output to ``stdout``. If ``OUTPUT`` is not
provided, the output path will be automatically chosen.
Download a series but do not apply it. ``OUTPUT`` is optional and can be an
output path or ``-`` to output to ``stdout``. If ``OUTPUT`` is not
provided, the output path will be automatically chosen.

.SH OPTIONS
.TP
\fB\-\-separate\fP
Expand Down
5 changes: 3 additions & 2 deletions man/git-pw-series-list.1
@@ -1,4 +1,4 @@
.TH "GIT-PW SERIES LIST" "1" "2022-03-24" "2.3.0" "git-pw series list Manual"
.TH "GIT-PW SERIES LIST" "1" "2022-12-06" "2.4.0" "git-pw series list Manual"
.SH NAME
git-pw\-series\-list \- List series.
.SH SYNOPSIS
Expand All @@ -7,7 +7,8 @@ git-pw\-series\-list \- List series.
.SH DESCRIPTION
List series.
.PP
List series on the Patchwork instance.
List series on the Patchwork instance.

.SH OPTIONS
.TP
\fB\-\-submitter\fP SUBMITTER
Expand Down
5 changes: 3 additions & 2 deletions man/git-pw-series-show.1
@@ -1,4 +1,4 @@
.TH "GIT-PW SERIES SHOW" "1" "2022-03-24" "2.3.0" "git-pw series show Manual"
.TH "GIT-PW SERIES SHOW" "1" "2022-12-06" "2.4.0" "git-pw series show Manual"
.SH NAME
git-pw\-series\-show \- Show information about series.
.SH SYNOPSIS
Expand All @@ -7,7 +7,8 @@ git-pw\-series\-show \- Show information about series.
.SH DESCRIPTION
Show information about series.
.PP
Retrieve Patchwork metadata for a series.
Retrieve Patchwork metadata for a series.

.SH OPTIONS
.TP
\fB\-f,\fP \-\-format [simple|table|csv|yaml]
Expand Down
13 changes: 7 additions & 6 deletions man/git-pw-series.1
@@ -1,4 +1,4 @@
.TH "GIT-PW SERIES" "1" "2022-03-24" "2.3.0" "git-pw series Manual"
.TH "GIT-PW SERIES" "1" "2022-12-06" "2.4.0" "git-pw series Manual"
.SH NAME
git-pw\-series \- Interact with series.
.SH SYNOPSIS
Expand All @@ -7,11 +7,12 @@ git-pw\-series \- Interact with series.
.SH DESCRIPTION
Interact with series.
.PP
Series are groups of patches, along with an optional cover letter.
Series are mostly dumb containers, though they also contain some
metadata themselves, such as a version (which is inherited by the
patches and cover letter) and a count of the number of patches
found in the series.
Series are groups of patches, along with an optional cover letter.
Series are mostly dumb containers, though they also contain some
metadata themselves, such as a version (which is inherited by the
patches and cover letter) and a count of the number of patches
found in the series.

.SH COMMANDS
.PP
\fBapply\fP
Expand Down

0 comments on commit 999a802

Please sign in to comment.