You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by James Green <ja...@gmail.com> on 2014/08/27 09:12:47 UTC
Adding comments to dependencies in POM
I have in the past wasted hours of effort trying to weed out dependency
issues where something has been added for reasons unknown. Removal leads to
breakage.
It would be helpful if, inside a POM, it were possible to add a comment
element to a dependency. I realise this is possible as an XML comment,
however having a POM field would let documentation engines record the
comment.
The same could be said for dependencies inside dependencyManagement.
It would of course have the side effect of auto completion within IDEs
showing authors how to "officially" comment on the reason for that work.
An idea.
James
Re: Adding comments to dependencies in POM
Posted by Anders Hammar <an...@hammar.net>.
A very good idea I think. Please add it as an improvement in JIRA and it
could be implemented in a future pom model version.
/Anders (mobile)
Den 27 aug 2014 09:13 skrev "James Green" <ja...@gmail.com>:
> I have in the past wasted hours of effort trying to weed out dependency
> issues where something has been added for reasons unknown. Removal leads to
> breakage.
>
> It would be helpful if, inside a POM, it were possible to add a comment
> element to a dependency. I realise this is possible as an XML comment,
> however having a POM field would let documentation engines record the
> comment.
>
> The same could be said for dependencies inside dependencyManagement.
>
> It would of course have the side effect of auto completion within IDEs
> showing authors how to "officially" comment on the reason for that work.
>
> An idea.
>
> James
>
Re: Adding comments to dependencies in POM
Posted by James Green <ja...@gmail.com>.
[ Dragging up a really old topic. ]
https://issues.apache.org/jira/browse/MNG-5803
Incidentally I would vote against a different namespace as comments are
likely to be of use to readers of Maven POMs even if they are used for
visual purposes.
On 27 August 2014 at 12:03, Robert Scholte <rf...@apache.org> wrote:
> I think it should be solved with a separate namespace, so the model
> parsing stays pure without metadata irrelevant for Maven.
> And it should already work right now, no need for the pom xsd to change,
> since the Maven pom-parser should ignore these kinds of elements/attributes.
>
> Robert
>
> Op Wed, 27 Aug 2014 12:15:00 +0200 schreef domi <do...@fortysix.ch>:
>
>
> +1
>> I think this would be a good idea, let us know about the issue, so we can
>> vote on it.
>> Domi
>>
>> On 27.08.2014, at 09:12, James Green <ja...@gmail.com> wrote:
>>
>> I have in the past wasted hours of effort trying to weed out dependency
>>> issues where something has been added for reasons unknown. Removal leads
>>> to
>>> breakage.
>>>
>>> It would be helpful if, inside a POM, it were possible to add a comment
>>> element to a dependency. I realise this is possible as an XML comment,
>>> however having a POM field would let documentation engines record the
>>> comment.
>>>
>>> The same could be said for dependencies inside dependencyManagement.
>>>
>>> It would of course have the side effect of auto completion within IDEs
>>> showing authors how to "officially" comment on the reason for that work.
>>>
>>> An idea.
>>>
>>> James
>>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
>> For additional commands, e-mail: users-help@maven.apache.org
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>
>
Re: Adding comments to dependencies in POM
Posted by Robert Scholte <rf...@apache.org>.
I think it should be solved with a separate namespace, so the model
parsing stays pure without metadata irrelevant for Maven.
And it should already work right now, no need for the pom xsd to change,
since the Maven pom-parser should ignore these kinds of
elements/attributes.
Robert
Op Wed, 27 Aug 2014 12:15:00 +0200 schreef domi <do...@fortysix.ch>:
> +1
> I think this would be a good idea, let us know about the issue, so we
> can vote on it.
> Domi
>
> On 27.08.2014, at 09:12, James Green <ja...@gmail.com> wrote:
>
>> I have in the past wasted hours of effort trying to weed out dependency
>> issues where something has been added for reasons unknown. Removal
>> leads to
>> breakage.
>>
>> It would be helpful if, inside a POM, it were possible to add a comment
>> element to a dependency. I realise this is possible as an XML comment,
>> however having a POM field would let documentation engines record the
>> comment.
>>
>> The same could be said for dependencies inside dependencyManagement.
>>
>> It would of course have the side effect of auto completion within IDEs
>> showing authors how to "officially" comment on the reason for that work.
>>
>> An idea.
>>
>> James
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Adding comments to dependencies in POM
Posted by domi <do...@fortysix.ch>.
+1
I think this would be a good idea, let us know about the issue, so we can vote on it.
Domi
On 27.08.2014, at 09:12, James Green <ja...@gmail.com> wrote:
> I have in the past wasted hours of effort trying to weed out dependency
> issues where something has been added for reasons unknown. Removal leads to
> breakage.
>
> It would be helpful if, inside a POM, it were possible to add a comment
> element to a dependency. I realise this is possible as an XML comment,
> however having a POM field would let documentation engines record the
> comment.
>
> The same could be said for dependencies inside dependencyManagement.
>
> It would of course have the side effect of auto completion within IDEs
> showing authors how to "officially" comment on the reason for that work.
>
> An idea.
>
> James
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org