Re: [PR] [MJARSIGNER-62] Enhanced documentation for usage of arguments [maven-jarsigner-plugin]

2023-12-11 Thread via GitHub


elharo merged PR #17:
URL: https://github.com/apache/maven-jarsigner-plugin/pull/17


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[PR] [MJARSIGNER-62] Enhanced documentation for usage of arguments [maven-jarsigner-plugin]

2023-12-10 Thread via GitHub


schedin opened a new pull request, #17:
URL: https://github.com/apache/maven-jarsigner-plugin/pull/17

   The author of 
https://issues.apache.org/jira/projects/MJARSIGNER/issues/MJARSIGNER-62 would 
like to use a 2-element additional argument to the jarsigner command line. The 
author believes that the problem they are having is that maven-jarsigner-plugin 
(on top of the https://github.com/apache/maven-jarsigner project) is quoting 
the arguments, and that is causing the problem.
   
   I believe that the author is not correct: it is how the arguments were used 
by the author that is the problem. But I still think that the author has a good 
point. I my opinion the `arguments` parameter is not properly documented. You 
must be experienced with Maven to understand how to use it. I have used Maven 
for many years, and I still have problems with this. This pull request improves 
the documentation, so it is understandable for even a novice Maven user. When 
this pull request is accepted, I think that MJARSIGNER-62 can be closed.
   
   As an example, the `-certchain` is used in the ticket description. For this 
specific parameter there already exists a dedicated parameter. If/when 
https://github.com/apache/maven-jarsigner-plugin/pull/14 is accepted this will 
also have a correct documentation on 
https://maven.apache.org/plugins/maven-jarsigner-plugin/sign-mojo.html
   
   As an example, in this pull request, I have selected a parameter that 
maven-jarsigner-plugin does not have support for: `-signedjar file`. This is a 
good parameter as an example because I don’t think maven-jarsigner-plugin will 
implement support for this (since maven-jarsigner-plugin is used to sign many 
jarfiles, it does not make sense to overwrite every jar into a single output 
jarfile).
   
   
   Example of rendered output:
   
![image](https://github.com/apache/maven-jarsigner-plugin/assets/8510257/ef70534f-1219-483e-8265-aee4e4a74d5d)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org