[JENKINS-9897] Doxygen plugin treats path separators in output path incorrectly - Jenkins Jira

Details

Type: Bug
Status: Reopened (View Workflow)
Priority: Major
Resolution: Unresolved
Component/s: doxygen-plugin
Labels:
None
Environment:
Windows 7 slave

Similar Issues:

Show

Description

For example, if the Doxyfile states:

OUTPUT_DIRECTORY = build/doc

publishing fails with:

Publishing Doxygen HTML results.
FATAL: error
hudson.AbortException: The directory 'C:\Build\workspace\myProject\build/doc\html' doesn't exist.
	at hudson.plugins.doxygen.DoxygenDirectoryParser.retrieveDoxygenDirectoryFromDoxyfile(DoxygenDirectoryParser.java:314)
	at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:65)
	at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:24)
	at hudson.FilePath$FileCallableWrapper.call(FilePath.java:1979)
	at hudson.remoting.UserRequest.perform(UserRequest.java:114)
	at hudson.remoting.UserRequest.perform(UserRequest.java:48)
	at hudson.remoting.Request$2.run(Request.java:270)
	at java.util.concurrent.Executors$RunnableAdapter.call(Unknown Source)
	at java.util.concurrent.FutureTask$Sync.innerRun(Unknown Source)
	at java.util.concurrent.FutureTask.run(Unknown Source)
	at java.util.concurrent.ThreadPoolExecutor$Worker.runTask(Unknown Source)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source)
	at hudson.remoting.Engine$1$1.run(Engine.java:59)
	at java.lang.Thread.run(Unknown Source)

Note the backslash/forward slash confusion in hudson.AbortException.

The cygwin version of doxygen correctly handles this Doxyfile. I have not tried any other Windows port.

Similar Issues:

Attachments

- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List
- Download All

Doxyfile
62 kB
2011-07-19 10:19

Activity

Ascending order - Click to sort in descending order

View 8 older comments

Balazs MEZODI added a comment - 2012-01-11 10:40

Regarding the "The output directory doesn't exist" failure:

It seems that the plugin assumes that the working directory of doxygen is the root folder of the workspace. Thus, the plugin tries to resolve all relative paths based on the root folder of the workspace.

If you are like me, and your doxygen working directory is not the root folder of the workspace, then you need a workaround. I usually use one of these:

Change the working folder of doxygen to the root folder of the workspace.
Create a second Doxyfile (I usually name it Doxyfile.jenkins), in which you update all relative paths based on the root folder of the workspace. Then configure jenkins to use Doxyfile.jenkins, while maven (or whatever build tool you use) should stay using the original Doxyfile. (Yes, this solution means you need to keep the two files synchronized...)

A suggestion: Perhaps an input field could be added to the plugin configuration, expecting the doxygen working directory.

Balazs MEZODI added a comment - 2012-01-11 10:40 Regarding the "The output directory doesn't exist" failure: It seems that the plugin assumes that the working directory of doxygen is the root folder of the workspace. Thus, the plugin tries to resolve all relative paths based on the root folder of the workspace. If you are like me, and your doxygen working directory is not the root folder of the workspace, then you need a workaround. I usually use one of these: Change the working folder of doxygen to the root folder of the workspace. Create a second Doxyfile (I usually name it Doxyfile.jenkins), in which you update all relative paths based on the root folder of the workspace. Then configure jenkins to use Doxyfile.jenkins, while maven (or whatever build tool you use) should stay using the original Doxyfile. (Yes, this solution means you need to keep the two files synchronized...) A suggestion: Perhaps an input field could be added to the plugin configuration, expecting the doxygen working directory.

Joe Gamache added a comment - 2012-01-25 13:24

Hendrik,

Could you enlighten the rest of us as to what you are talking about? "Start the doxygen tool" doesn't really say much, at least to me. I am having the same issue and am on a unix machine. Doxygen there does not appear to have any type of server process, so I can't figure out what "tool" you are starting. Is this a windows only thing?

Thanks for providing some more detail.

Joe Gamache added a comment - 2012-01-25 13:24 Hendrik, Could you enlighten the rest of us as to what you are talking about? "Start the doxygen tool" doesn't really say much, at least to me. I am having the same issue and am on a unix machine. Doxygen there does not appear to have any type of server process, so I can't figure out what "tool" you are starting. Is this a windows only thing? Thanks for providing some more detail.

Hendrik Fuß added a comment - 2012-01-26 08:17

Hi,

Again, I apologize for causing confusion. Here's for clarification:

With "doxygen tool" I meant the command line client. When I first tried the Jenkins doxygen plugin I was a Jenkins newbie, and I wasn't aware of the fact that I had to take care of invoking doxygen myself using a build step. So in that respect the error message was completely justified – the output directory indeed wasn't there, because I failed to run doxygen.

That's why I was saying, as far as I'm concerned, the issue can be closed.

What would definitely help newbies like I've been, is to have some sort of step-by-step instructions on how to set up doxygen with Jenkins. Ie first create a new build step to run doxygen, second tick the check mark for the doxygen plugin etc. etc.

cheers
Hendrik

Hendrik Fuß added a comment - 2012-01-26 08:17 Hi, Again, I apologize for causing confusion. Here's for clarification: With "doxygen tool" I meant the command line client. When I first tried the Jenkins doxygen plugin I was a Jenkins newbie, and I wasn't aware of the fact that I had to take care of invoking doxygen myself using a build step. So in that respect the error message was completely justified – the output directory indeed wasn't there, because I failed to run doxygen. That's why I was saying, as far as I'm concerned, the issue can be closed. What would definitely help newbies like I've been, is to have some sort of step-by-step instructions on how to set up doxygen with Jenkins. Ie first create a new build step to run doxygen, second tick the check mark for the doxygen plugin etc. etc. cheers Hendrik

Jenkins User added a comment - 2012-06-21 06:49

I am seeing the same error:

hudson.AbortException: The output directory doesn't exist.
at hudson.plugins.doxygen.DoxygenDirectoryParser.retrieveDoxygenDirectoryFromDoxyfile(DoxygenDirectoryParser.java:343)

My problem is OUTPUT_DIRECTORY in the doxyfile is set to an environment variable:

OUTPUT_DIRECTORY = $(DOCDIR)

echo $DOCDIR
doxygen-doc

However Jenkins' doxygen-plugin (I am using version 0.10) is not able to evaluate this environment variable while reading the doxyfile.

What are my options to work around this issue?

Jenkins User added a comment - 2012-06-21 06:49 I am seeing the same error: hudson.AbortException: The output directory doesn't exist. at hudson.plugins.doxygen.DoxygenDirectoryParser.retrieveDoxygenDirectoryFromDoxyfile(DoxygenDirectoryParser.java:343) My problem is OUTPUT_DIRECTORY in the doxyfile is set to an environment variable: OUTPUT_DIRECTORY = $(DOCDIR) echo $DOCDIR doxygen-doc However Jenkins' doxygen-plugin (I am using version 0.10) is not able to evaluate this environment variable while reading the doxyfile. What are my options to work around this issue?

Jenkins User added a comment - 2012-06-21 07:54 - edited

My mistake. Doxygen Plugin (0.10) already has a fix for this issue:

It provides an 'advanced' button, after clicking this, a new field shows up titled:

Folder from which doxygen is run
(Give the path from where you run doxygen relative to the root of the workspace)

I entered the value of OUTPUT_DIRECTORY (DOCDIR) here and doxygen documents were successfully being published after this.

Jenkins User added a comment - 2012-06-21 07:54 - edited My mistake. Doxygen Plugin (0.10) already has a fix for this issue: It provides an 'advanced' button, after clicking this, a new field shows up titled: Folder from which doxygen is run (Give the path from where you run doxygen relative to the root of the workspace) I entered the value of OUTPUT_DIRECTORY (DOCDIR) here and doxygen documents were successfully being published after this.

Jenkins

Doxygen plugin treats path separators in output path incorrectly

Details

Description

Attachments

Attachments

Activity

People

Dates