Bug#707093: reproducing the build and the upload process of libhtmlcleaner-java

[Geert Stappers]

Hello Alexandre,
Hello People reading ITP libhtmlcleaner-java,
and hello Debian Java People,

Summary:
Please document the maintainers workflow for libhtmlcleaner-java,
have a debian/README.soure in the git repository.

This is an e-mail about wanting to help, but being helpless.
About wanting to go beyond helpless and being helpfull.

There is Debian Bug report #707093
ITP: libhtmlcleaner-java -- Java HTML Parser library
( http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=707093 )

Alexandre Rossi did the packing work, but has no upload privilege.
Geert Stappers has upload privilege, but can't review the work of Alexandre.

It is part my ignorance and part missing documentation.

To solve my ignorance am I, stappers, willing to learn. To solve missing documentation
is my proposal add a debian/README.source file. See http://wiki.debian.org/Java/JavaVcs
for minimal content.

In the README.source having documented how to "convert" the .zip from upstream
into the git repository would also be a good thing.


The command `dpkg-buildpackage -uc -us` gives this
<output>
dpkg-source -b libhtmlcleaner-java
dpkg-source: error: can't build with source format '3.0 (quilt)': no upstream tarball found at ../libhtmlcleaner-java_2.2.orig.tar.{bz2,gz,lzma,xz}
dpkg-buildpackage: error: dpkg-source -b libhtmlcleaner-java gave error exit status 255
</output>

If something else as `dpkg-buildpackage` should be used, please document it.


Groeten
Geert Stappers
--
> And is there a policy on top-posting vs. bottom-posting?
Yes.


--
To UNSUBSCRIBE, email to debian-bugs-...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listm...@lists.debian.org

[tony mancill]

Hi Geert, Alexandre:

In general the issue appears to be that there's no orig.tar.gz file and
not documentation about how to create one. Alexandre, on May 10th you
posted to the bug report that you uploaded the packages (presumably one
of which was libhtmlcleaner-java) to mentors.debian.net, but I'm not
able to find them. That source package would have included an
.orig.tar.gz file.

While it's possible to recreate the upstream orig.tar.gz from the
upstream branch in the git repository using git-archive, it would be
preferable going forward to use pristine-tar to create a pristine-tar
branch. (Since you already have an upstream branch it won't take up
much extra space.)

And from that, was able to build a package using "debuild -us -uc".
However, the packaging repo in pkg-java/libhtmlcleaner-java.git is kind
of a mess. Newer upstream versions 2.2.1 and 2.4 have already been
committed and merged, but the files in debian/ (changelog and patches)
are for the 2.2 version. Thus, the package can't build when the master
branch of the git repository has been merged with upstream/2.4, but the
debian/changelog is expecting an orig.tar.gz version 2.2.

If you just want to see how it build, you can follow these steps:

# clone the pkg-java repo
git clone git+ssh://git.debian.org/git/pkg-java/libhtmlcleaner-java.git
cd libhtmlcleaner-java

# (re)create the upstream tarball for the 2.2 version
git archive upstream/2.2 --prefix=libhtmlcleaner-java-2.2/ -o
../libhtmlcleaner-java_2.2.orig.tar.gz

# clean up the 2.4 sources that are currently there
# (as an alternative, you could copy ./debian/ to a new folder)
rm -rf .git __MACOSX src

# restore the 2.2 sources
tar --strip-components=1 -xvf ../libhtmlcleaner-java_2.2.orig.tar.gz

# build!
debuild -us -uc


While this "works," it's completely and deeply flawed from a
git-buildpackage work-flow point of view. Alexandre, what I recommend
doing is to:

1) Get a working source package for whatever version it is you want to
package and then make that package available on mentors.debian.net.
Iterate over that package until your sponsor feels it is ready for Debian.

2) Completely erase the existing pkg-java/libhtmlcleaner-java.git repo
so we can start over fresh.

3) Use git-import-dsc to create a local gbp repository for your package.

4) Verify that your package builds with git-buildpackage.

5) Push the newly created repository, including the upstream and
pristine-tar branches, to pkg-java/libhtmlcleaner-java.git.

Hope that helps,
tony

[Geert Stappers]

Op 2013-05-19 om 20:34 schreef tony mancill:

>
> If you just want to see how it build, you can follow these steps:
>
> # clone the pkg-java repo
> git clone git+ssh://git.debian.org/git/pkg-java/libhtmlcleaner-java.git
> cd libhtmlcleaner-java
>
> # (re)create the upstream tarball for the 2.2 version
> git archive upstream/2.2 --prefix=libhtmlcleaner-java-2.2/ -o
> ../libhtmlcleaner-java_2.2.orig.tar.gz
>
> # clean up the 2.4 sources that are currently there
> # (as an alternative, you could copy ./debian/ to a new folder)
> rm -rf .git __MACOSX src
>
> # restore the 2.2 sources
> tar --strip-components=1 -xvf ../libhtmlcleaner-java_2.2.orig.tar.gz
>
> # build!
> debuild -us -uc
>

That information got me back on track.

I'm now making "white space changes" to fix warnings as
| dpkg-source: warning: file libhtmlcleaner-java/src/test/resources/Expected_1.html has no final newline (either original or modified version)
to see what is causing
| dpkg-source: error: unrepresentable changes to source

| dpkg-buildpackage: error: dpkg-source -b libhtmlcleaner-java gave error exit status 2

Tony: Thank you!

[Geert Stappers]

Op 2013-05-21 om 22:05 schreef Geert Stappers:

> Op 2013-05-19 om 20:34 schreef tony mancill:
> >
> > If you just want to see how it build, you can follow these steps:
> >

[ good instructions ]

> >
>
> That information got me back on track.
>
> I'm now making "white space changes" to fix warnings as
> | dpkg-source: warning: file libhtmlcleaner-java/src/test/resources/Expected_1.html has no final newline (either original or modified version)
> to see what is causing
> | dpkg-source: error: unrepresentable changes to source
> | dpkg-buildpackage: error: dpkg-source -b libhtmlcleaner-java gave error exit status 2

That seems to be gone due to white space changes.

My next action will this Lintian message:

E: libhtmlcleaner-java: helper-templates-in-copyright


Groeten
Geert Stappers
--
Leven en laten leven

[Alexandre Rossi]

Hi,

> In general the issue appears to be that there's no orig.tar.gz file and
> not documentation about how to create one. Alexandre, on May 10th you
> posted to the bug report that you uploaded the packages (presumably one
> of which was libhtmlcleaner-java) to mentors.debian.net, but I'm not
> able to find them. That source package would have included an
> .orig.tar.gz file.

http://mentors.debian.net/package/libhtmlcleaner-java
http://mentors.debian.net/package/davmail

> 2) Completely erase the existing pkg-java/libhtmlcleaner-java.git repo
> so we can start over fresh.

I had begun work on packaging the latest upstream version, but got
stuck because of :
- messy source tarball which is now fixed thanks to collaboration with upstream
- switch to maven as build system, which needs a bit of learning on my side.

I'll be working on this, but the version on mentors.debian.org seems
pretty acceptable to me for review.

Regarding the git repo issue, I can branch of the debian/2.2-1_pre+1
tag in order to take into account packaging review comments, while
working on getting 2.5 in shape. Or I can start over for master to be
exactly what has been uploaded at mentors.d.n and keep my work on 2.5
private. Please advice.

Alex


--
To UNSUBSCRIBE, email to debian-ja...@lists.debian.org

with a subject of "unsubscribe". Trouble? Contact listm...@lists.debian.org

Archive: http://lists.debian.org/CAM79t8GnMBp3=7N6S5rvSRGBLT7oDRXHNhR8AnR+0hcB4hqr=Q...@mail.gmail.com

[Alexandre Rossi]

> My next action will this Lintian message:
>
> E: libhtmlcleaner-java: helper-templates-in-copyright

False positive. But anyway I switched the package to DEP-5 yesterday
which should fix the issue.

See http://anonscm.debian.org/gitweb/?p=pkg-java/libhtmlcleaner-java.git;a=commitdiff;h=63976bf5f660eef5371d63b117b2396e70e9e76d

Alex

[Geert Stappers]

Op 2013-05-24 om 15:37 schreef Alexandre Rossi:

>
> I'll be working on this, but the version on mentors.debian.org seems
> pretty acceptable to me for review.
>
> Regarding the git repo issue, I can branch of the debian/2.2-1_pre+1
> tag in order to take into account packaging review comments, while
> working on getting 2.5 in shape. Or I can start over for master to be
> exactly what has been uploaded at mentors.d.n and keep my work on 2.5
> private. Please advice.

My advice: Work on 2.5, push the commit to the Alioth repository.


My plan: Reviewing 2.2
and uploading it with the warm feeling that 2.5 is waiting.

>
> Alex

[Geert Stappers]

Op 2013-05-24 om 15:43 schreef Alexandre Rossi:

> > My next action will this Lintian message:
> >
> > E: libhtmlcleaner-java: helper-templates-in-copyright
>
> False positive. But anyway I switched the package to DEP-5 yesterday
> which should fix the issue.

Yes, it should ...

> See http://anonscm.debian.org/gitweb/?p=pkg-java/libhtmlcleaner-java.git;a=commitdiff;h=63976bf5f660eef5371d63b117b2396e70e9e76d
>

Then there is/was:

$ lintian -I
W: libhtmlcleaner-java source: missing-field-in-dep5-copyright license (paragraph at line 6)
W: libhtmlcleaner-java source: missing-field-in-dep5-copyright license (paragraph at line 38)
E: libhtmlcleaner-java: copyright-should-refer-to-common-license-file-for-gpl

This patch does fix it:
--- a/debian/copyright
+++ b/debian/copyright
@@ -5,7 +5,7 @@ Source: http://htmlcleaner.sourceforge.net

Files: *
Copyright: 2006-2010 Vladimir Nikic
-Licence: BSD htmlcleaner
+License: BSD-3-clause
Redistribution and use of this software in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met:
@@ -37,4 +37,7 @@ Licence: BSD htmlcleaner

Files: debian/*
Copyright: 2011 Alexandre Rossi
-Licence: GPL-2
+License: GPL-2
+ On Debian systems, the full text of the GNU General Public
+ License version 2 can be found in the file
+ `/usr/share/common-licenses/GPL-2'.


Please allow me to commit it to the Alioth git repository.

[Geert Stappers]

Op 2013-05-26 om 09:19 schreef Alexandre Rossi:

> > Please allow me to commit it to the Alioth git repository.
>

> Go on, thanks!

Done