summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorXimin Luo <infinity0@pwned.gg>2014-05-05 03:06:52 +0100
committerBenjamin Drung <bdrung@debian.org>2014-05-09 22:57:52 +0200
commitfe9f32bbddda697c0784c0015c49b391e010ef47 (patch)
tree1121d032a567f864544aba2b1b08b7b5bcacff7c /man
parent371dfdaf755804dceea2c27c17ac115ea48c6e51 (diff)
add amo-changelog, a script for fetching version history from the amo website
Diffstat (limited to 'man')
-rw-r--r--man/amo-changelog.156
1 files changed, 56 insertions, 0 deletions
diff --git a/man/amo-changelog.1 b/man/amo-changelog.1
new file mode 100644
index 0000000..197ff17
--- /dev/null
+++ b/man/amo-changelog.1
@@ -0,0 +1,56 @@
+.\" Copyright (c) 2014 Ximin Luo <infinity0@pwned.gg>
+.\"
+.\" Permission to use, copy, modify, and/or distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.TH XPI-REPACK "1" "April 2014" "amo-changelog" "mozilla-devscripts suite"
+.SH NAME
+amo-changelog \- fetch Version History of an addon
+.SH SYNOPSIS
+.B amo-changelog
+[\fIoptions\fP]
+\fIextension\fR
+.SH DESCRIPTION
+.B amo-changelog
+fetches the Version History of an addon from the Mozilla Extensions website.
+It is meant to offer an easy way to include upstream changelogs in Debian
+packages of mozilla extensions - in many cases, this is not contained in the
+upstream source code repository, but is available on said website.
+
+The \fIextension\fR argument is its short name, as used by the website. For
+example, the homepage for "Adblock Plus" is
+https://addons.mozilla.org/en-US/firefox/addon/adblock-plus/, so the
+short name would be "adblock-plus".
+
+Here is an example for debian/rules:
+
+# if using debhelper
+.br
+override_dh_installchangelogs:
+.br
+ dh_installchangelogs debian/changelog.upstream
+
+\[char46]PHONY: get-orig-changelog
+.br
+get-orig-changelog:
+.br
+ amo-changelog adblock-plus > debian/changelog.upstream
+
+Using this approach, one would save the output file (debian/changelog.upstream)
+as part of the Debian packaging. When updating the package with a new upstream
+release, one would run `debian/rules get-orig-changelog`
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a brief help message.
+.SH AUTHOR
+Jakub Wilk <jwilk@debian.org> and Ximin Luo <infinity0@pwned.gg>