Issue Details (XML | Word | Printable)

Key: MJAVADOC-162
Type: Bug Bug
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Benjamin Bentmann
Reporter: Greg Thompson
Votes: 1
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Maven 2.x Javadoc Plugin

javadocExecutable unusable

Created: 16/Nov/07 01:35 PM   Updated: 18/Apr/08 10:56 AM   Resolved: 18/Apr/08 10:56 AM
Return to search
Component/s: None
Affects Version/s: 2.3
Fix Version/s: 2.5

Time Tracking:
Not Specified

File Attachments: 1. Text File javadoc-executable.patch (1 kB)

Environment: Windows XP and non-Windows


 Description  « Hide

AbstractJavadocMojo tries to be smart by seeing if the file indicated by javadocExecutable exists, but this is actually quite problematic. If you put the following in your config:

<javadocExecutable>blahblahblah${file.separator}javadoc</javadocExecutable>

then you'll get an error on Windows since the file is actually javadoc.exe, which is a pain since it's perfectly acceptable to omit the .exe when executing a command.

If you put .exe in the config, then it won't work on non-Windows platforms since the files doesn't have .exe.

Forcing users to add hackery to their POMs to add .exe in some cases and leave it off in others is onerous.

Methinks it's much preferable to simply use the path provided by the config. If it doesn't exist, let CommandLineUtils.executeCommandLine (or something else) throw an exception.



Vincent Siveton made changes - 17/Jan/08 07:19 AM
Field Original Value New Value
Fix Version/s 2.4 [ 13630 ]
Wendy Smoak added a comment - 05/Mar/08 08:40 PM

Vincent, you marked this for 2.4 back in January. Are you planning to work on it, or should we bump it to 2.5? I'd like to stage 2.4 this weekend.


Wendy Smoak made changes - 07/Mar/08 09:39 PM
Fix Version/s 2.4 [ 13630 ]
Benjamin Bentmann added a comment - 08/Mar/08 07:23 AM

Patch attached. The logic has been extended to accept "<snip>/javadoc" on all platforms by appending ".exe" automatically on Windows boxes.

Besides the fix, I made the parameter accept a mere directory spec, too, as a matter of convenience.


Benjamin Bentmann made changes - 08/Mar/08 07:23 AM
Attachment javadoc-executable.patch [ 33066 ]
Benjamin Bentmann added a comment - 18/Apr/08 10:56 AM

Fixed in r649582.


Benjamin Bentmann made changes - 18/Apr/08 10:56 AM
Assignee Benjamin Bentmann [ bentmann ]
Resolution Fixed [ 1 ]
Fix Version/s 2.5 [ 14120 ]
Status Open [ 1 ] Closed [ 6 ]