aboutsummaryrefslogtreecommitdiffstats
path: root/Tools/scripts/README.getpatch
diff options
context:
space:
mode:
authorsbz <sbz@FreeBSD.org>2012-08-30 18:23:01 +0800
committersbz <sbz@FreeBSD.org>2012-08-30 18:23:01 +0800
commit19be475a58805f614bd68ed6f503d3836a03708c (patch)
treea48e0d220f4cce8eed0be99c9d6e3d1a3efa1cf5 /Tools/scripts/README.getpatch
parent0c6c0e4d70288f1f170cf6e049da183f99567759 (diff)
downloadfreebsd-ports-gnome-19be475a58805f614bd68ed6f503d3836a03708c.tar.gz
freebsd-ports-gnome-19be475a58805f614bd68ed6f503d3836a03708c.tar.zst
freebsd-ports-gnome-19be475a58805f614bd68ed6f503d3836a03708c.zip
- Fix documentation
Submitted by: culot, gahr
Diffstat (limited to 'Tools/scripts/README.getpatch')
-rw-r--r--Tools/scripts/README.getpatch42
1 files changed, 22 insertions, 20 deletions
diff --git a/Tools/scripts/README.getpatch b/Tools/scripts/README.getpatch
index ed84cc19dae6..e601e1bfb4f9 100644
--- a/Tools/scripts/README.getpatch
+++ b/Tools/scripts/README.getpatch
@@ -1,37 +1,39 @@
GETPATCH(1) FreeBSD General Commands Manual GETPATCH(1)
NAME
- getpatch - An utility to download patch attachments on Bug Tracking Systems
+ getpatch - A utility to download patch attachments on Bug Tracking Systems
SYNOPSIS
getpatch [-h] [--mode gnats|bz] [--last] [--stdout] <pr-id>
DESCRIPTION
- getpatch is an utility to download patch attachments on Bug Tracking
- Systems such Gnats and Bugzilla. It currently supports retrieving multiple
+ getpatch is a utility to download patch attachments from Bug Tracking
+ Systems such Gnats and Bugzilla. It supports retrieving multiple
attachments from the command line.
- Its written in python witout any extra dependencies. Compare to getpr
- utility it does web scrapping on BTS web interface in order to retrieve
- patchs attached.
+ It's written in python witout any extra dependencies. In addition to the
+ functionalities offered by other similar tools suchs as getpr, it does web
+ scrapping on the BTS web interface in order to retrieve the patches attached
+ to PR.
The following command line options are supported:
- -h Prints a multi-line help message and exits
+ -h Prints a multi-line help message and exits.
- --mode Specify BTS mode. Supported are "gnats" or "bz".
+ --mode Specifies the BTS. Currently "gnats" and "bz" are.
+ supported.
- --last Only retrieve last iteration patch attached.
+ --last Only retrieves the latest iteration of a patch.
- --stdout Output patch to stdout file descriptor.
+ --stdout Dumps the patch to stdout file descriptor.
- Options can be used after or before the <pr-id> on the command line.
+ Options can be used after or before the <pr-id> argument on the command line.
FILES
${PORTSDIR}/Tools/scripts/getpatch
EXAMPLES
- Retrieve all patchs attached on pr ports/166692 on a Gnats BTS:
+ Retrieve all patches attached to PR ports/166692 from a Gnats BTS:
getpatch --mode gnats ports/166692
@@ -39,21 +41,21 @@ EXAMPLES
getpatch 166692
- Gnats is the default mode and category isn't mandatory.
+ Gnats is the default BTS and category isn't mandatory.
- Retrieve all patchs on a Bugzilla BTS:
+ Retrieve all patches attached to PR ports/166692 from a Bugzilla BTS:
getpatch --mode bz ports/166692
- Retrieve only last iteration of the patch:
+ Retrieve only the latest iteration of the patch:
getpatch --last ports/166692
- Retrieve patch on standard output
+ Retrieve a patch on dump it to standard output
getpatch --stdout ports/166692
- On fly patching can be done in a port directory this way:
+ From inside a port's directory, patching on the fly can be done as follows:
For a diff
@@ -65,16 +67,16 @@ EXAMPLES
cd ${PORTSDIR}/category/port
sh <(getpatch 166692 --stdout)
- Redirection <() depends on the shell you're using, validated with zsh and bash.
+ Redirection <() depends on the shell you're using; validated with zsh and bash.
DIAGNOSTICS
- getpatch exits 0 on success or 1 if a help message was output.
+ getpatch exits 0 on success or 1 if a help message was displayed.
SEE ALSO
getpr, prpatch
AUTHORS
- Sofian Brabez <sbz@freebsd.org>
+ Sofian Brabez <sbz@FreeBSD.org>
BUGS
If you're using getpatch and you encounter a bug or want an improvement