summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org>2018-10-08 10:17:49 (GMT)
committer Sergey Poznyakoff <gray@gnu.org>2018-10-08 10:17:49 (GMT)
commitb40849278f8868a0ff9a7ec277b5ce85bdc9766b (patch) (side-by-side diff)
treef456366c403801fd25dae8187b3c8248f73a1a3f
parent4d47b48c141a381cbb07f4d0ecc0ef367a4d5c23 (diff)
downloadreleaselogparser-b40849278f8868a0ff9a7ec277b5ce85bdc9766b.tar.gz
releaselogparser-b40849278f8868a0ff9a7ec277b5ce85bdc9766b.tar.bz2
Fix RST markup. New release.v1.0.1
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--CHANGES.txt2
-rw-r--r--README.rst31
-rw-r--r--setup.py4
3 files changed, 19 insertions, 18 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
index d25072c..d9dfef1 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1 +1 @@
-v1.0, 2018-10-08 -- Initial release.
+v1.0.1, 2018-10-08 -- Initial release.
diff --git a/README.rst b/README.rst
index 87e6e43..1d19395 100644
--- a/README.rst
+++ b/README.rst
@@ -28,19 +28,19 @@ them overnumber their differences. The following observations hold true:
1. Release logs are plaintext files.
2. Within a file, each release is described by a separate entry.
3. Each such entry consists of a heading, containing at least the
-version number and date of the release, and a textual block discussing
-the changes introduced with this release.
+ version number and date of the release, and a textual block discussing
+ the changes introduced with this release.
4. Entries are arranged in reverse chronological order, the most
-recent release being described first.
+ recent release being described first.
5. Format of the headings is consistent throughout the given release
-log.
+ log.
6. Entry description is usually a list of changes. However, more
-verbose and general descriptions may also appear within it. In
-general, it is safest to assume the description to be an opaque block
-of arbitrary text.
+ verbose and general descriptions may also appear within it. In
+ general, it is safest to assume the description to be an opaque block
+ of arbitrary text.
7. Release logs can contain additional textual information before the
-first release entry (a "prologue") and after the last release entry
-(an "epilogue").
+ first release entry (a "prologue") and after the last release entry
+ (an "epilogue").
Supported Formats
=================
@@ -99,9 +99,9 @@ Valid format names for this version of ``releaselogparser`` are:
Supported keyword arguments are:
start = *N*
- Start parsing from the *N*th entry. Entries are numbered from 0.
+ Start parsing from the entry *N*. Entries are numbered from 0.
stop = *N*
- Stop parsing on *N*th entry.
+ Stop parsing on the entry *N*.
count = *N*
Collect at most *N* entries
@@ -169,7 +169,7 @@ Extending Release Log
=====================
Implementing support for new release log format is fairly easy. To do
so, provide a class inherited from ``ReleaseHistory``. This base class has
-the following attributes::
+the following attributes:
``format``
List of names for this format. Names from this list can be used
@@ -240,13 +240,14 @@ given file or URL. Its usage is::
The argument is treated as file name by default. To read from a URL,
use the ``--url`` option.
-Options::
+Options:
+
``-H FORMAT``, ``--format=FORMAT``
Read logs in the given format.
``-f N``, ``--from=N``, ``--start=N``
- Start from *N*th entry.
+ Start from *N* th entry.
``-t N``, ``--to=N``, ``--stop=N``
- End on *N*th entry.
+ End on *N* th entry.
``-n COUNT``, ``--count=COUNT``
Read at most that much entries.
``-u``, ``--url``
diff --git a/setup.py b/setup.py
index 9aa0024..751081c 100644
--- a/setup.py
+++ b/setup.py
@@ -22,10 +22,10 @@ with open("README.rst", "r") as fh:
long_description = fh.read()
setup(name='releaselogparser',
- version='1.0',
+ version='1.0.1',
author='Sergey Poznyakoff',
author_email='gray@gnu.org',
- url='http://git.gnu.org.ua/cgit/gsc/releaselogparser.git/',
+ url='http://git.gnu.org.ua/cgit/releaselogparser.git/',
packages = find_packages(exclude=['contrib', 'docs',
'tests', 'testdata']),
scripts=['bin/releaselog'],

Return to:

Send suggestions and report system problems to the System administrator.