Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[Markus Koschany]

Am 18.10.2015 um 03:39 schrieb tony mancill:
> On Fri, 16 Oct 2015 20:35:24 +1000 dean  wrote:
>> On 10/15/15 04:41, Markus Koschany wrote:
> 
>>> I think we will fix this with the next revision of bouncycastle
>>> one way or the other.
>>
>> I might leave this one for the experts, this one is frustrating me ;-)
> 
> The vagaries of the interactions between the umpteen Java build systems
> and the Debian Java toolchains can be frustrating.  I'm going to take a
> look as this; we have many packages that fail to generate javadocs due
> to not explicitly setting the encoding, and it would be nice to get them
> cleaned up for stretch.

[...]

I wonder if we should change the default encoding to UTF-8 whenever one
of our build tools like Ant, Maven or Gradle are used. It should still
be possible to override the default encoding but UTF-8 appears to be the
better choice than ANSI.

What do you think?

Markus





signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[tony mancill]

On 10/18/2015 06:10 AM, Markus Koschany wrote:
> Am 18.10.2015 um 03:39 schrieb tony mancill:
>> On Fri, 16 Oct 2015 20:35:24 +1000 dean  wrote:
>>> On 10/15/15 04:41, Markus Koschany wrote:
>>
 I think we will fix this with the next revision of bouncycastle
 one way or the other.
>>>
>>> I might leave this one for the experts, this one is frustrating me ;-)
>>
>> The vagaries of the interactions between the umpteen Java build systems
>> and the Debian Java toolchains can be frustrating.  I'm going to take a
>> look as this; we have many packages that fail to generate javadocs due
>> to not explicitly setting the encoding, and it would be nice to get them
>> cleaned up for stretch.
> 
> [...]
> 
> I wonder if we should change the default encoding to UTF-8 whenever one
> of our build tools like Ant, Maven or Gradle are used. It should still
> be possible to override the default encoding but UTF-8 appears to be the
> better choice than ANSI.
> 
> What do you think?

I think that's a great idea.  I'm glad you brought it up.




signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[tony mancill]

On Fri, 16 Oct 2015 20:35:24 +1000 dean  wrote:
> On 10/15/15 04:41, Markus Koschany wrote:

> > I think we will fix this with the next revision of bouncycastle
> > one way or the other.
> 
> I might leave this one for the experts, this one is frustrating me ;-)

The vagaries of the interactions between the umpteen Java build systems
and the Debian Java toolchains can be frustrating.  I'm going to take a
look as this; we have many packages that fail to generate javadocs due
to not explicitly setting the encoding, and it would be nice to get them
cleaned up for stretch.

I'm also going to convert the packaging repo to git.

Cheers,
tony



signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[tony mancill]

On Sat, 17 Oct 2015 18:39:32 -0700 tony mancill  wrote:

> I'm also going to convert the packaging repo to git.

Correction - the migration had already happened, but the SVN repo never
got marked as MOVED_TO_GIT.  That step is now complete.



signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[dean]

On 10/15/15 04:41, Markus Koschany wrote:
Hi Markus,

> ANSI is the default encoding for your Java platform and if you want to
> have a specific encoding that is identical on all platforms you have to
> tell Ant about it, for instance you can use ant -Dfile.encoding=UTF-8 on
> the command line or you can use the already mentioned ant.properties
> file. 

I'm not having any luck with this, ant -debug is printing:
Override ignored for property "file.encoding"
when I tried to set it via ant.properties

> I think we will fix this with the next revision of bouncycastle
> one way or the other.

I might leave this one for the experts, this one is frustrating me ;-)

> It's completely fine to reply to the bug report. We have a dedicated bug
> mailing list too and all your e-mails to the bug report are
> automatically forwarded to it. Keeping the bug report in CC also ensures
> that other interested parties can follow the conversation without having
> to subscribe to a dedicated mailing list like debian-java. Therefore I
> suggest to continue the discussion by only writing to the bug report.

Understood

Thanks for your help and time,
Dean.



signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[Markus Koschany]

Am 14.10.2015 um 13:08 schrieb dean:
> On 10/11/15 22:27, Markus Koschany wrote:
>> On Sun, 11 Oct 2015 12:48:45 +1000 dean  
> Hi Markus and list,
> 
>>
>> I think there is even a simpler way to change the source encoding. In
>> Debian we normally use an ant.properties file for that.
> 
> bouncycastle is already using a bc-build.properties Would it be
> appropriate to use that?

Hi dean,

that would probably work too. However you have to patch that file again
because it is part of the upstream sources whereas an ant.properties
file is part of Debian's packaging and can just be placed into the
debian directory.

>> A line like encoding=UTF-8 or compile.encoding=UTF-8 should do the 
>> trick. It should be even possible to drop the 01_build.patch but I 
>> haven't tested this yet.
>>
> 
> I originally looked at something like that but I could not make it work.
> I think something is setting file.encoding -> ANSI_X3.4-1968
> but I cannot find out where. I don't know a lot about bouncycastle but I
> believe they use different encodings in their source for a reason.
> 
> Any suggestions? I'm out of my league here.

ANSI is the default encoding for your Java platform and if you want to
have a specific encoding that is identical on all platforms you have to
tell Ant about it, for instance you can use ant -Dfile.encoding=UTF-8 on
the command line or you can use the already mentioned ant.properties
file. I think we will fix this with the next revision of bouncycastle
one way or the other.

> ps. I CC'ed this to the list instead of the bug to keep the noise down
> on the bug report while troubleshooting, I hope this was the right way to go

It's completely fine to reply to the bug report. We have a dedicated bug
mailing list too and all your e-mails to the bug report are
automatically forwarded to it. Keeping the bug report in CC also ensures
that other interested parties can follow the conversation without having
to subscribe to a dedicated mailing list like debian-java. Therefore I
suggest to continue the discussion by only writing to the bug report.

Cheers,

Markus






signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[Markus Koschany]

On Sun, 11 Oct 2015 12:48:45 +1000 dean  wrote:
> Tags: patch
> 
> Greetings all,
> 
> I have confirmed this bug is related to source file encoding.
> I believe I have fixed this in the attached patch.
> 
> Please review - this is my first debian bug fix.

Hi dean,

thanks for your patch. I think there is even a simpler way to change the
source encoding. In Debian we normally use an ant.properties file for
that. A line like encoding=UTF-8 or compile.encoding=UTF-8 should do the
trick. It should be even possible to drop the 01_build.patch but I
haven't tested this yet.

Regards,

Markus



signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[dean]

Tags: patch

Greetings all,

I have confirmed this bug is related to source file encoding.
I believe I have fixed this in the attached patch.

Please review - this is my first debian bug fix.

Thanks,
Dean
diff -Nru bouncycastle-1.49+dfsg/debian/changelog 
bouncycastle-1.49+dfsg/debian/changelog
--- bouncycastle-1.49+dfsg/debian/changelog 2014-10-22 21:41:06.0 
+1000
+++ bouncycastle-1.49+dfsg/debian/changelog 2015-10-11 11:01:38.0 
+1000
@@ -1,3 +1,10 @@
+bouncycastle (1.49+dfsg-3.1) UNRELEASED; urgency=medium
+
+  * Non-maintainer upload.
+  * bc+-build.xml: Added javac encoding=UTF-8 (Closes: #798343) 
+
+ -- dean   Sun, 11 Oct 2015 10:56:33 +1000
+
 bouncycastle (1.49+dfsg-3) unstable; urgency=medium
 
   * Replaced the dependency on libgnumail-java with libmail-java
diff -Nru bouncycastle-1.49+dfsg/debian/patches/fix-encoding.patch 
bouncycastle-1.49+dfsg/debian/patches/fix-encoding.patch
--- bouncycastle-1.49+dfsg/debian/patches/fix-encoding.patch1970-01-01 
10:00:00.0 +1000
+++ bouncycastle-1.49+dfsg/debian/patches/fix-encoding.patch2015-10-11 
12:14:23.0 +1000
@@ -0,0 +1,44 @@
+Index: bouncycastle/bc+-build.xml
+===
+--- bouncycastle.orig/bc+-build.xml
 bouncycastle/bc+-build.xml
+@@ -95,7 +95,8 @@
+ 
++debug="${release.debug}"
++  encoding="UTF-8">
+ 
+ 
+ 
+@@ -130,7 +131,8 @@
+ 
++debug="${release.debug}"
++  encoding="UTF-8">
+ 
+ 
+ 
+@@ -190,7 +192,8 @@
+ 
++ header="bBouncy Castle Cryptography Library 
${release.name}/b"
++   encoding="UTF-8">
+ 
+ 
+ 
+@@ -246,7 +249,8 @@
+ 
++debug="${release.debug}"
++  encoding="UTF-8">
+ 
+ 
+ 
diff -Nru bouncycastle-1.49+dfsg/debian/patches/series 
bouncycastle-1.49+dfsg/debian/patches/series
--- bouncycastle-1.49+dfsg/debian/patches/series2014-10-22 
21:21:21.0 +1000
+++ bouncycastle-1.49+dfsg/debian/patches/series2015-10-11 
11:04:00.0 +1000
@@ -1,2 +1,3 @@
 01_build.patch
 02_index.patch
+fix-encoding.patch


signature.asc
Description: OpenPGP digital signature
__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.

Bug#798343: libbcprov-java-doc: Package does not contain docs, api folder empty

[dean]

Package: libbcprov-java-doc
Version: 1.49+dfsg-3
Severity: important

Dear Maintainer,

This package does not contain any html documentation when donloaded and
installed with apt.
This only appears to affect jessie, stretch, sid and experimental. Squeeze and
wheezy contain the docs.
I have built the package locally with apt-get --build source libbcprov-java-doc
and apt-get source libbcprov-java-doc then debuild -us -uc
and the package was built with the javadocs. I have java 1.8 installed.



-- System Information:
Debian Release: stretch/sid
  APT prefers testing-updates
  APT policy: (500, 'testing-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

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

-- no debconf information

__
This is the maintainer address of Debian's Java team
. 
Please use
debian-j...@lists.debian.org for discussions and questions.