GNU bug report logs - #55929
[PATCH] gnu: maven: Add maven-doxia-sink-api

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 55929 in the body.
You can then email your comments to 55929 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: guix-patches <at> gnu.org
Subject: [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sun, 12 Jun 2022 21:25:03 +0300

[Message part 1 (text/plain, inline)]

Hello,

this patch adds 'Doxia Sink API'[1] under the name
'maven-doxia-sink-api'.

The module contains a Java interface that is used by Doxia Core module.

This patch is the first in the future patch set based on my effort to
add Doxia modules.

The Doxia itself required for other useful Maven plugins.

- Artyom

References:
1. https://maven.apache.org/doxia/doxia/doxia-sink-api/

[0001-gnu-maven-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

-- 
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #8 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: guix-patches <at> gnu.org
Subject: Re: [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sun, 12 Jun 2022 21:45:36 +0300

[Message part 1 (text/plain, inline)]

My goodness, I just found out that I mistakenly committed (and
submitted) some extra code with the patch.

Here's the fixed version of it.

- Artyom

[0001-gnu-maven-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

-- 
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #11 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sun, 12 Jun 2022 23:03:22 +0200

Great to see someone trying to package more maven-related stuff! I
think I've seen it in the dependency graph to the maven-plugin-plugin,
which I'd like to package at some point to make our life easier.

Le Sun, 12 Jun 2022 21:45:36 +0300,
"Artyom V. Poptsov" <poptsov.artyom <at> gmail.com> a écrit :

> From b4020bc283f18d7b7394976c4288d04130f1e651 Mon Sep 17 00:00:00 2001
> From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
> Date: Sun, 12 Jun 2022 21:42:33 +0300
> Subject: [PATCH] gnu: maven: Add maven-doxia-sink-api

Here the subject should omit "maven", so simply:

gnu: Add maven-doxia-sink-api.

> 
> * gnu/packages/maven.scm (maven-doxia-sink-api): New variable.
> ---
>  gnu/packages/maven.scm | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
> 
> diff --git a/gnu/packages/maven.scm b/gnu/packages/maven.scm
> index 817fee1c71..93c1538bae 100644
> --- a/gnu/packages/maven.scm
> +++ b/gnu/packages/maven.scm
> @@ -3,6 +3,7 @@
>  ;;; Copyright © 2019 Tobias Geerinckx-Rice <me <at> tobias.gr>
>  ;;; Copyright © 2019 Björn Höfling
> <bjoern.hoefling <at> bjoernhoefling.de> ;;; Copyright © 2020 Efraim
> Flashner <efraim <at> flashner.co.il> +;;; Copyright © 2022 Artyom V.
> Poptsov <poptsov.artyom <at> gmail.com> ;;;
>  ;;; This file is part of GNU Guix.
>  ;;;
> @@ -3887,3 +3888,31 @@ reports in two different file formats, plain
> text and xml."))) (description "This plugin provides the capability
> to build jars.  If you would like to sign jars please use the Maven
> Jarsigner Plugin instead.") (license license:asl2.0)))
> +
> +(define-public maven-doxia-sink-api
> +  (package
> +    (name "maven-doxia-sink-api")
> +    (version "2.0.0-M2")
> +    (source (origin
> +              (method git-fetch)
> +              (uri (git-reference
> +                    (url
> "https://gitbox.apache.org/repos/asf/maven-doxia.git")
> +                    (commit (string-append "doxia-" version))))
> +              (file-name (git-file-name "doxia" version))
> +              (sha256
> +               (base32
> +
> "0jx96lg0hgjsrm8mynhac4hwh2hmgiwjpwpx2k03yr14040zcr48"))))
> +    (build-system ant-build-system)
> +    (native-inputs
> +     (list java-javax-inject))
> +    (arguments
> +     (list #:jar-name "doxia-core.jar"

Is this intentional? Shouldn't it be doxia-sink-api.jar?

> +           #:source-dir "doxia-sink-api/src/main/java"
> +           #:tests? #f))                ; no tests

Also I'm wondering, since this will be used by maven eventually,
shouldn't we install it to lib/m2 with its pom file? To do so, we would
change the install phase to something like this:

(replace 'install (install-from-pom "doxia-sink-api/pom.xml"))

This might require a parent-pom (probably the top-level pom.xml and
maybe its own parent pom), so you'll have to provide a patch for it
as well. You can have a look at (gnu packages maven-parent) for
examples.

> +    (home-page "https://maven.apache.org/doxia/index.html")
> +    (synopsis "Generic markup language interface")
> +    (description "The @code{Sink} interface is a generic markup
> language +interface provided as a Java API. It contains several
> methods that encapsulate +common text syntax. A start tag is denoted
> by @code{xxxx()} method and a end +of tag by @code{xxxx_()} method.")

The description doesn't follow all our conventions, in particular,
double space between sentences :)

> +    (license license:asl2.0)))

Thanks!

Message #14 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Mon, 13 Jun 2022 07:29:43 +0300

[Message part 1 (text/plain, inline)]

Hello Julien,

first of all, thanks for reviewing my patches!

I fixed my patch, at least the part I understood -- see below.

> Great to see someone trying to package more maven-related stuff! I
> think I've seen it in the dependency graph to the maven-plugin-plugin,
> which I'd like to package at some point to make our life easier.

Indeed, I started my work on packaging Doxia because I wanted to package
'maven-plugin-plugin' which in turn is required for
'maven-release-plugin'[1].  And 'maven-release-plugin' is required for
'java-json-simple'[2] ...

So the dependency order looks like this:
0. 'ugs' (Universal G-Code sender) [3]
1. 'java-jts'
2. 'java-json-simple'
3. 'maven-release-plugin'
4. 'maven-plugin-plugin' <-- I'm here.  ;-)

Also, while we on it, I have the following questions:
0. How did you check the dependency graph for 'maven-plugin-plugin'
   without packaging it?
1. Is it possible with Guix to generate the reverse dependency graph to
   see that packages depend on the specified package?

> Here the subject should omit "maven", so simply:

Done.

> Is this intentional? Shouldn't it be doxia-sink-api.jar?

That was a mistake indeed.  Fixed it.

> Also I'm wondering, since this will be used by maven eventually,
> shouldn't we install it to lib/m2 with its pom file? To do so, we would
> change the install phase to something like this:

> (replace 'install (install-from-pom "doxia-sink-api/pom.xml"))

Done.

> This might require a parent-pom (probably the top-level pom.xml and
> maybe its own parent pom), so you'll have to provide a patch for it
> as well. You can have a look at (gnu packages maven-parent) for
> examples.

This part I don't understand.  Could you elaborate?

> The description doesn't follow all our conventions, in particular,
> double space between sentences :)

Fixed.

- Artyom

References:
1. https://maven.apache.org/maven-release/maven-release-plugin/
2. https://github.com/fangyidong/json-simple
3. https://github.com/winder/Universal-G-Code-Sender

[0001-gnu-maven-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

--
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #17 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Mon, 13 Jun 2022 07:38:29 +0300

[Message part 1 (text/plain, inline)]

Sorry, attached the old version of the patch by a mistake.
Here's the updated version.

- Artyom

[0001-gnu-maven-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

-- 
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #20 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Mon, 13 Jun 2022 07:41:58 +0200

Le Mon, 13 Jun 2022 07:29:43 +0300,
"Artyom V. Poptsov" <poptsov.artyom <at> gmail.com> a écrit :

> Hello Julien,
> 
> first of all, thanks for reviewing my patches!
> 
> I fixed my patch, at least the part I understood -- see below.
> 
> > Great to see someone trying to package more maven-related stuff! I
> > think I've seen it in the dependency graph to the
> > maven-plugin-plugin, which I'd like to package at some point to
> > make our life easier.  
> 
> Indeed, I started my work on packaging Doxia because I wanted to
> package 'maven-plugin-plugin' which in turn is required for
> 'maven-release-plugin'[1].  And 'maven-release-plugin' is required for
> 'java-json-simple'[2] ...
> 
> So the dependency order looks like this:
> 0. 'ugs' (Universal G-Code sender) [3]
> 1. 'java-jts'
> 2. 'java-json-simple'
> 3. 'maven-release-plugin'
> 4. 'maven-plugin-plugin' <-- I'm here.  ;-)
> 
> Also, while we on it, I have the following questions:
> 0. How did you check the dependency graph for 'maven-plugin-plugin'
>    without packaging it?
> 1. Is it possible with Guix to generate the reverse dependency graph
> to see that packages depend on the specified package?

0. I tried to package it, but somehow it was more difficult than I
expected and I had other projects. Apache projects have "dependencies"
link on their web page, like this one:
https://maven.apache.org/plugin-tools/maven-plugin-plugin/dependencies.html
where they list all dependencies.

1. guix graph -t reverse-package (or guix graph -t reverse-bag), see
guix graph --list-types for more options.

> 
> > This might require a parent-pom (probably the top-level pom.xml and
> > maybe its own parent pom), so you'll have to provide a patch for it
> > as well. You can have a look at (gnu packages maven-parent) for
> > examples.  
> 
> This part I don't understand.  Could you elaborate?

The installed pom contains the following:

<parent>
 <artifactId>doxia</artifactId>
 <groupId>org.apache.maven.doxia</groupId>
 <version>2.0.0-M2</version>
 <relativePath>../pom.xml</relativePath>
</parent>

If the referenced pom file is not installed, it won't be found by Maven
later when we use it to run the maven-plugin-plugin. See for instance
how the parent pom is installed in java-slf4j-parent, and propagated
from java-slf4j-api (and recursively from java-slf4j-simple).

This top-level pom also has the following, so it should propagate it:

<parent>
 <groupId>org.apache.maven</groupId>
 <artifactId>maven-parent</artifactId>
 <version>34</version>
 <relativePath />
</parent>

We already have it: maven-parent-pom-34.

Message #23 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sat, 18 Jun 2022 18:34:50 +0300

[Message part 1 (text/plain, inline)]

Hello.

> If the referenced pom file is not installed, it won't be found by Maven
> later when we use it to run the maven-plugin-plugin. See for instance
> how the parent pom is installed in java-slf4j-parent, and propagated
> from java-slf4j-api (and recursively from java-slf4j-simple).

> This top-level pom also has the following, so it should propagate it:

> <parent>
>  <groupId>org.apache.maven</groupId>
>  <artifactId>maven-parent</artifactId>
>  <version>34</version>
>  <relativePath />
> </parent>

> We already have it: maven-parent-pom-34.

Done.  Please see the patch, I'm hoping it should be OK by now.

[0001-gnu-maven-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

- Artyom

-- 
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #26 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sat, 18 Jun 2022 18:52:16 +0200

On June 18, 2022 5:34:50 PM GMT+02:00, "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com> wrote:
>Hello.
>
>> If the referenced pom file is not installed, it won't be found by Maven
>> later when we use it to run the maven-plugin-plugin. See for instance
>> how the parent pom is installed in java-slf4j-parent, and propagated
>> from java-slf4j-api (and recursively from java-slf4j-simple).
>
>> This top-level pom also has the following, so it should propagate it:
>
>> <parent>
>>  <groupId>org.apache.maven</groupId>
>>  <artifactId>maven-parent</artifactId>
>>  <version>34</version>
>>  <relativePath />
>> </parent>
>
>> We already have it: maven-parent-pom-34.
>
>Done.  Please see the patch, I'm hoping it should be OK by now.
>

Hi,

I think you sent the same patch as previously?

Message #29 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sat, 18 Jun 2022 19:57:15 +0300

[Message part 1 (text/plain, inline)]

Oh sorry, it happens to me every now and then.

Here's the right one.

[0001-gnu-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

- Artyom

-- 
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #32 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sat, 18 Jun 2022 20:00:13 +0200

Thanks for the new patch :)

Le Sat, 18 Jun 2022 19:57:15 +0300,
"Artyom V. Poptsov" <poptsov.artyom <at> gmail.com> a écrit :

> +    (native-inputs
> +     (list java-javax-inject))
> +    (propagated-inputs
> +     (list maven-parent-pom-34))

Sorry if my previous messages were confusing you. I meant to have a new
package maven-doxia-parent (or similar name) that contains only the
parent pom file. You're propagating the grand-parent. I think this
would be more correct:

(propagated-inputs (list maven-doxia-parent))

and maven-doxia-parent would be something like:

(define maven-doxia-parent
  (package
    (inherit maven-doxia-sink-api)
    (name "maven-doxia-parent")
    (arguments
     `(#:tests? #f
       #:phases
       (modify-phases %standard-phases
         (delete 'configure)
         (delete 'build)
         (replace 'install (install-pom-file "pom.xml")))))
    (synopsis "...")
    (description "...")))

This is untested, of course :)

Since we "define" and not "define-public" (we don't want it to be
accessible from other modules or the command-line), you can put both
packages in the same patch.

> +    (arguments
> +     `(#:jar-name "doxia-sink-api.jar"
> +       #:source-dir "doxia-sink-api/src/main/java"
> +       #:tests? #f ; no tests
> +       #:phases (modify-phases %standard-phases
> +                  (replace 'install
> +                    (install-from-pom "doxia-sink-api/pom.xml")))))

That's correct :)

Message #35 received at 55929 <at> debbugs.gnu.org (full text, mbox):

From: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 55929 <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sun, 19 Jun 2022 07:55:12 +0300

[Message part 1 (text/plain, inline)]

Hello Julien,

thanks for help.  I think I'm beginning to better understand the
child/parent POM relationships now.

Here's the updated patch.

[0001-gnu-Add-maven-doxia-sink-api.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

- Artyom

-- 
Artyom "avp" Poptsov <poptsov.artyom <at> gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[signature.asc (application/pgp-signature, inline)]

Message #40 received at 55929-done <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: "Artyom V. Poptsov" <poptsov.artyom <at> gmail.com>
Cc: 55929-done <at> debbugs.gnu.org
Subject: Re: [bug#55929] [PATCH] gnu: maven: Add maven-doxia-sink-api
Date: Sun, 19 Jun 2022 21:03:08 +0200

[Message part 1 (text/plain, inline)]

Le Sun, 19 Jun 2022 07:55:12 +0300,
"Artyom V. Poptsov" <poptsov.artyom <at> gmail.com> a écrit :

> Hello Julien,
> 
> thanks for help.  I think I'm beginning to better understand the
> child/parent POM relationships now.
> 
> Here's the updated patch.
> 

Thanks, pushed to master as 0d461393e444a993a469b521d4cf46dee9e2767e. I
changed the commit message to add a dot at the end of the first
sentence. I added maven-parent-pom-34 as a propagated-input to
maven-doxia-parent-pom, and removed java-javax-inject from
maven-doxia-sink-api because it's not needed.

[Message part 2 (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.