What |Removed |Added ---------------------------------------------------------------------------- CC| |from_bugzilla@nospam.homelin | |ux.org
------- Comment #3 from Gingko 2008-11-28 09:22 UTC ------- Hello,
I had this bug several times on several computers without ever understanding why. On many places on Internet I saw users reporting having "fixed" it using the SHORT_NAMES option (try this search: http://www.google.com/search?q=%22Error+opening+map+file%22+SHORT_NAMES ), but this didn't make sense to me.
But I finally ran in a strange situation which probably makes me finding the real reason of this problem : I have two folders which contain two side by side forks of the same project. Each of them have their own configuration files, but these configuration files are absolutely identical. There was no apparent reason for that but ... when generating their respective Doxygen documentation, one of these projects had the bug and the second one not !
Thinking a lot, I tried several things, and I ended with the following : cleaning all Doxygen generated files (in the "html" folder) in the faulty project was enough for removing the bug (that is, after doing that, the new generation ran with no error).
I think now that the problem is the following :
It looks like that Doxygen has an incremental feature (that is, if you generate the same documentation several times, only changed files will be reprocessed, thus improving speed). But that way, if the previous generation was faulty, several things will not get fixed. Especially if "map" files were missing because there was an error in the previous generation. And the main reason for having "map" files missing is trying to generate graphics without having "graphViz" installed.
So probably many users proceed on the following way when using "Doxygen" for the first time :
(1) They download and install Doxygen. (2) They try to use it for documenting some of their own projects. (3) At a given time, they try to enable the "dot" (graphViz) for generating the project. (4) They get a lot of errors because graphViz was not installed. Of course it wasn't, it is not included with Doxyfile! But they didn't read that yet so they return to the manual and they see that they now need to download and install graphViz (alternatively, maybe they have installed it, but not correctly). (5) After having fixed the graphViz installation problem, they run Doxygen again on the same project. (6) Things seem to work a little better, but now they have plenty of these "Error opening map file *.map for inclusion in the docs!". The reason is that the previous generation left a corrupted documentation in the folder, but they don't know it. (7) They search on Internet the reason of this error and they find that many people have fixed it by setting the SHORT_NAMES option to YES. (8) They try this, and it works. They are happy.
But what they don't know is that if the SHORT_NAMES trick works, it is not because this option was the reason of the bug, but rather that it completely changes almost all the names inside the folder, so the previous generation is not seen: a completely new set of files is generated (actually leaving the previous files orphan in the folder, which could be seen as another bug as they uselessly take space; but this is another problem).
If they had begun their first try by setting the SHORT_NAMES option to YES, they would have now to set it to NO for getting the same result.
So the correct workaround is cleaning the previous generation rather than changing the "SHORT_NAMES" option if you see this "Error opening map file *.map for inclusion in the docs!" message.
... and the bug fix could be trying to regenerate the picture if some "map" file is found missing during an incremental regeneration rather than issuing an error and ignoring this part of the project.
18 comments:
Anonymous said...-
-
March 27, 2008 8:35 PM
Anonymous said...
-
-
March 28, 2008 4:36 PM
Vinz said...
-
-
March 30, 2008 8:20 PM
Mihir said...
-
-
March 31, 2008 3:14 PM
Aaron said...
-
-
April 5, 2008 5:11 AM
Nikhil Manohar. said...
-
-
April 8, 2008 3:49 PM
Anonymous said...
-
-
May 2, 2008 2:22 PM
Anonymous said...
-
-
June 1, 2008 11:42 AM
Anonymous said...
-
-
July 10, 2008 4:37 PM
Anonymous said...
-
-
July 10, 2008 4:39 PM
Thorsten said...
-
-
September 6, 2008 8:16 PM
tom said...
-
-
September 20, 2008 7:51 AM
Anonymous said...
-
-
September 26, 2008 1:15 AM
Anonymous said...
-
-
October 8, 2008 1:51 AM
Anonymous said...
-
-
October 17, 2008 8:12 AM
Anonymous said...
-
-
October 30, 2008 12:23 AM
Mihir said...
-
-
November 29, 2008 11:04 AM
Peter K. said...
-
-
December 18, 2008 10:45 PM
god bless you!! you saved me!!
That made it work for me!
Thanks!
Thank's you! You have solved my problem.
Why don't you report the "bug" and your solution to eclox developes?
I don;t think this is a bug. although changing the default parameter can solve this.
I will try to report it.
Thanks for the suggestion.
thanks, worked
Thanks Man!
That saved my time!!
Thanks! :)
Thanks a lot a man,
I start believing in Doxygen.
I love you very much good Sir. This information is very valuable to me.
Thank you very much.
After changing this option it started working for me.
Thank you very much!
After changing this options it started working for me.
you saved me as well. I did a
grep -i "short" Doxyfile
and found
SHORT_NAMES = NO
after replacing it, doxygen finally worked.
where can I find the "Short Names" tag so I can change it? I'm looking in the "Expert" tab of Doxywizard the doxygen GUI. mnay thanks,
Under Expert->"Project" tab, there's a check box called "SHORT_NAMES". This box, disabled by default, should be *checked*.
Tjohoooo! It workes!
Works perfectly now! Awesome!
For me it worked only after I have set:
FULL_PATH_NAMES = NO
SHORT_NAMES = NO
Hope this helps someone...
You can add comments to this bug at:
http://bugzilla.gnome.org/show_bug.cgi?id=525273
doxygen | general | Ver: 1.5.5
Gingko changed:
What |Removed |Added
----------------------------------------------------------------------------
CC| |from_bugzilla@nospam.homelin
| |ux.org
------- Comment #3 from Gingko 2008-11-28 09:22 UTC -------
Hello,
I had this bug several times on several computers without ever understanding
why. On many places on Internet I saw users reporting having "fixed" it using
the SHORT_NAMES option (try this search:
http://www.google.com/search?q=%22Error+opening+map+file%22+SHORT_NAMES ), but
this didn't make sense to me.
But I finally ran in a strange situation which probably makes me finding the
real reason of this problem :
I have two folders which contain two side by side forks of the same project.
Each of them have their own configuration files, but these configuration files
are absolutely identical. There was no apparent reason for that but ... when
generating their respective Doxygen documentation, one of these projects had
the bug and the second one not !
Thinking a lot, I tried several things, and I ended with the following :
cleaning all Doxygen generated files (in the "html" folder) in the faulty
project was enough for removing the bug (that is, after doing that, the new
generation ran with no error).
I think now that the problem is the following :
It looks like that Doxygen has an incremental feature (that is, if you generate
the same documentation several times, only changed files will be reprocessed,
thus improving speed). But that way, if the previous generation was faulty,
several things will not get fixed. Especially if "map" files were missing
because there was an error in the previous generation. And the main reason for
having "map" files missing is trying to generate graphics without having
"graphViz" installed.
So probably many users proceed on the following way when using "Doxygen" for
the first time :
(1) They download and install Doxygen.
(2) They try to use it for documenting some of their own projects.
(3) At a given time, they try to enable the "dot" (graphViz) for generating the
project.
(4) They get a lot of errors because graphViz was not installed. Of course it
wasn't, it is not included with Doxyfile! But they didn't read that yet so they
return to the manual and they see that they now need to download and install
graphViz (alternatively, maybe they have installed it, but not correctly).
(5) After having fixed the graphViz installation problem, they run Doxygen
again on the same project.
(6) Things seem to work a little better, but now they have plenty of these
"Error opening map file *.map for inclusion in the docs!". The reason is that
the previous generation left a corrupted documentation in the folder, but they
don't know it.
(7) They search on Internet the reason of this error and they find that many
people have fixed it by setting the SHORT_NAMES option to YES.
(8) They try this, and it works. They are happy.
But what they don't know is that if the SHORT_NAMES trick works, it is not
because this option was the reason of the bug, but rather that it completely
changes almost all the names inside the folder, so the previous generation is
not seen: a completely new set of files is generated (actually leaving the
previous files orphan in the folder, which could be seen as another bug as they
uselessly take space; but this is another problem).
If they had begun their first try by setting the SHORT_NAMES option to YES,
they would have now to set it to NO for getting the same result.
So the correct workaround is cleaning the previous generation rather than
changing the "SHORT_NAMES" option if you see this "Error opening map file *.map
for inclusion in the docs!" message.
... and the bug fix could be trying to regenerate the picture if some "map"
file is found missing during an incremental regeneration rather than issuing an
error and ignoring this part of the project.
Gilles
Yet again, THANKS!
Post a Comment