Package: shunit2
Version: 2.1.6-1.1
Severity: wishlist

Hi Ulrich,

I noticed that the man page for shunit2 didn't look very nice on my
system so I had a look at it.  One thing led to another, and I have
several changes to recommend.

Please find attached a debdiff.  Despite what the changelog says, I have
no plans to actually NMU this package unless you'd like me to.  Please
consider everything friendly suggestions.

Thanks for maintaining this package!

$ debdiff shunit2_2.1.6-1.[12].dsc|diffstat
 changelog        |   20 +++++++++
 control          |   16 +++----
 copyright        |    2 
 rules            |    2 
 shunit2.1.txt    |   57 ----------------------------
 shunit2.man      |  111 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 shunit2.manpages |    2 
 7 files changed, 141 insertions(+), 69 deletions(-)

-- System Information:
Debian Release: 9.0
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64
 (x86_64)

Kernel: Linux 4.9.0-2-amd64 (SMP w/4 CPU cores)
Locale: LANG=C, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

-- no debconf information
diff -Nru shunit2-2.1.6/debian/changelog shunit2-2.1.6/debian/changelog
--- shunit2-2.1.6/debian/changelog      2015-09-12 17:03:56.000000000 -0400
+++ shunit2-2.1.6/debian/changelog      2017-05-01 11:08:00.000000000 -0400
@@ -1,3 +1,23 @@
+shunit2 (2.1.6-1.2) experimental; urgency=medium
+
+  * Non-maintainer upload.
+  * debian/control: Note movement of upstream to a new site (Google Code
+    to GitHub).
+  * debian/shunit2.man: Rewrite in groff.
+    + debian/shunit2.1.txt: Delete.
+    + debian/control: Drop build dependencies on asciidoc, docbook-xsl,
+      and xsltproc.
+    + debian/rules: Remove generation and cleanup of man page.
+    + debian/shunit2.manpages: Update file reference.
+  * debian/control: Make style fixes to description.
+    + Use hyphens in adjectival phrases.
+    + Wrap at 80 columns.
+    + Use monospaced-font-friendly inter-sentence spacing.
+    + Recast sentence to not end in "etc." and also add information.
+  * debian/control: Bump Standards-Version to 3.9.8.
+
+ -- G. Branden Robinson <g.branden.robin...@gmail.com>  Mon, 01 May 2017 
11:08:00 -0400
+
 shunit2 (2.1.6-1.1) unstable; urgency=medium
 
   * Non-maintainer upload.
diff -Nru shunit2-2.1.6/debian/control shunit2-2.1.6/debian/control
--- shunit2-2.1.6/debian/control        2015-09-12 16:58:36.000000000 -0400
+++ shunit2-2.1.6/debian/control        2017-05-01 11:07:06.000000000 -0400
@@ -3,15 +3,15 @@
 Priority: optional
 Maintainer: Ulrich Dangel <m...@spamt.net>
 Build-Depends: debhelper (>= 9)
-Build-Depends-Indep: asciidoc, docbook-xsl, mksh, xsltproc, zsh
-Standards-Version: 3.9.3
-Homepage: http://code.google.com/p/shunit2/
+Build-Depends-Indep: mksh, zsh
+Standards-Version: 3.9.8
+Homepage: https://github.com/kward/shunit2/
 
 Package: shunit2
 Architecture: all
 Depends: ${misc:Depends}
-Description: unit test framework for Bourne based shell scripts
- shUnit2 was originally developed to provide a consistent testing
- solution for log4sh, a shell based logging framework similar to
- log4j. It is designed to work in a similar manner to JUnit, PyUnit,
- etc.
+Description: unit test framework for Bourne-based shell scripts
+ shUnit2 was originally developed to provide a consistent testing solution for
+ log4sh, a shell-based logging framework similar to log4j.  It is designed to
+ work in a similar manner to JUnit, PyUnit, and other xUnit frameworks.
+# vim:set textwidth=80:
diff -Nru shunit2-2.1.6/debian/copyright shunit2-2.1.6/debian/copyright
--- shunit2-2.1.6/debian/copyright      2012-03-25 11:26:58.000000000 -0400
+++ shunit2-2.1.6/debian/copyright      2017-05-01 10:57:54.000000000 -0400
@@ -1,6 +1,6 @@
 Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: shUnit2
-Source: http://code.google.com/p/shunit2/
+Source: https://github.com/kward/shunit2/
 
 Files: *
 Copyright: 2007 - 2012 Kate Ward <kate.w...@forestent.com>
diff -Nru shunit2-2.1.6/debian/rules shunit2-2.1.6/debian/rules
--- shunit2-2.1.6/debian/rules  2012-03-25 11:20:27.000000000 -0400
+++ shunit2-2.1.6/debian/rules  2017-05-01 10:12:58.000000000 -0400
@@ -8,7 +8,6 @@
 
 override_dh_auto_build-indep:
        cp -r examples examples.debian
-       a2x -a revnumber=$(UPSTREAM_VERSION) -L -fmanpage debian/shunit2.1.txt
        find examples.debian -type f -print0 | xargs -0r sed -i -e 
"s#../src/##g"
 
 override_dh_installchangelogs:
@@ -18,6 +17,5 @@
        cd src && ./shunit2_test.sh
 
 override_dh_clean:
-       rm -f debian/shunit2.1 debian/shunit2.1.xml
        rm -rf examples.debian
        dh_clean
diff -Nru shunit2-2.1.6/debian/shunit2.1.txt shunit2-2.1.6/debian/shunit2.1.txt
--- shunit2-2.1.6/debian/shunit2.1.txt  2012-03-25 06:19:15.000000000 -0400
+++ shunit2-2.1.6/debian/shunit2.1.txt  1969-12-31 19:00:00.000000000 -0500
@@ -1,57 +0,0 @@
-shunit2(1)
-==========
-
-Name
-----
-shunit2 - A unit test framework for shell scripts
-
-Synopsis
---------
-shunit2 unitfile
-
-Description
-------------
-shUnit2 is a xUnit unit test framework for Bourne based shell scripts, and it
-is designed to work in a similar manner to JUnit, PyUnit, etc.. If you have
-ever had the desire to write a unit test for a shell script, shUnit2 can do the
-job.
-
-You can either run *shunit2* directly from the commandline and specify the 
unit file or directly source the *shunit2* executable.
-
-If you directly execute *shunit2* and *don't* specify a unitfile shunit2 
assumes a empty testfile and will return without an error message.
-
-Example
---------
-
-Simple script to test if 1 equals 1
-----
-#! /bin/sh
-testEquality()
-{
-  assertEquals 1 1
-}
-
-# load shunit2
-. shunit2
-
-----
-
-Execute shUnit2 unit tests directly from the commandline
-----
-shunit2 /path/to/unit/file
-----
-
-Options
--------
-
-*shunit2* does not support any commandline options at all. You can either 
source shunit2 to execute your unit tests or directly run shunit2 as a 
commandline script.
-
-See also
---------
-
-For more information see http://code.google.com/p/shunit2/ or have a look at
-the installed documentation in /usr/share/doc/shunit2/
-
-Author
-------
-*shunit2* was written by Kate Ward <kate.w...@forestent.com>. This manpage was 
written by Ulrich Dangel <m...@spamt.net>.
diff -Nru shunit2-2.1.6/debian/shunit2.man shunit2-2.1.6/debian/shunit2.man
--- shunit2-2.1.6/debian/shunit2.man    1969-12-31 19:00:00.000000000 -0500
+++ shunit2-2.1.6/debian/shunit2.man    2017-05-01 10:54:06.000000000 -0400
@@ -0,0 +1,111 @@
+.TH shunit2 1 2012-03-25 "shunit2 2.1.6"
+.SH Name
+.B shunit2
+\-
+unit test framework for shell scripts
+.SH Synopsis
+.B shunit2
+.I unit-file
+.SH Description
+.I shUnit2
+is an
+.IR x Unit
+unit test framework for Bourne-based shell scripts, and is designed to
+work in a similar manner to
+.IR JUnit ,
+.IR PyUnit ,
+and so forth.
+If you have ever had the desire to write a unit test for a shell script,
+.I shUnit2
+can do the job.
+.PP
+You can either run
+.B shunit2
+directly from the command line and specify the unit file
+.I unit-file
+or directly source the
+.B shunit2
+executable.
+.PP
+If you directly execute
+.B shunit2
+and
+.I don't
+specify
+.IR unit-file ,
+.I shUnit2
+assumes an empty test file and will return without an error message.
+.SH Options
+.B shunit2
+does not support any command-line options at all.
+You can either source
+.B shunit2
+with the shell's
+.B .\&
+(\[lq]dot\[rq]) built-in to execute your unit tests or directly run
+.B shunit2
+as a command with
+.I unit-file
+as a parameter.
+.SH Example
+The following simple script tests whether 1 equals 1.
+.RS
+.EX
+.B #! /bin/sh
+.B testEquality()
+.B {
+.B \ \ assertEquals 1 1
+.B }
+.PP
+.B # load shunit2
+.B . shunit2
+.EE
+.RE
+.PP
+The following is a shell session transcript showing how to write the
+same test as above and execute it directly.
+.RS
+.EX
+$ \c
+.B cat > test_equality.sh <<EOF
+.B testEquality()
+.B {
+.B \ \ assertEquals 1 1
+.B }
+.B EOF
+$ \c
+.B shunit2 test_equality.sh
+.EE
+.RE
+Note that
+.B shunit2
+is
+.I not
+sourced in this example.
+.PP
+More sophisticated examples can be found in
+.UR file:///usr/share/doc/shunit2/examples/
+.UE .
+.SH Authors
+.I shUnit2
+was written by
+.MT kate.w...@forestent.com
+Kate Ward
+.ME .
+This man page was written by
+.MT m...@spamt.net
+Ulrich Dangel
+.ME .
+.SH See also
+For more information, see
+.UR https://github.com/kward/shunit2/
+the shUnit2 GitHub project
+.UE ,
+or have a look at the
+.UR file:///usr/share/doc/shunit2/
+installed documentation
+.UE .
+.\" Local Variables:
+.\" mode: nroff
+.\" End:
+.\" vim:set filetype=nroff:
diff -Nru shunit2-2.1.6/debian/shunit2.manpages 
shunit2-2.1.6/debian/shunit2.manpages
--- shunit2-2.1.6/debian/shunit2.manpages       2011-09-01 04:54:27.000000000 
-0400
+++ shunit2-2.1.6/debian/shunit2.manpages       2017-05-01 11:01:14.000000000 
-0400
@@ -1 +1 @@
-debian/shunit2.1
+debian/shunit2.man

Attachment: signature.asc
Description: PGP signature

Reply via email to