Ticket #706 (assigned defect)

Opened 2 years ago

Last modified 2 weeks ago

scanning algorithm?

Reported by: WBrainerd@activision.com Assigned to: cboos (accepted)
Priority: normal Component: DoxygenPlugin
Severity: normal Keywords: MESSAGE
Cc: Riyadh Trac Release: 0.10

Description

Hi, I'm having some trouble getting this plugin to work with more than one Doxygen directory - it keeps putting "html" in the wrong places.

My generated HTML files are in the following directories:

c:/tl/base/doc/html/* c:/tl/ngl/doc/html/* c:/tl/apk/doc/html/* c:/tl/apk/tools/apkedit/doc/html/*

I set my root to 'c:/', and put the tag [doxygen:tl/ngl/doc] with html_out as 'html', and all I get are error pages.

Now, say I have a class apkString in apkedit, it would be great to be able to write [doxygen:apkString] and have the plugin just find it. Maybe support for multiple defaults would covert it.

Best regards,

Wade Brainerd Technical Directory Activision Central Technology

Attachments

win32_port-r1251.diff (3.1 kB) - added by ttressieres on 12/07/06 10:30:58.
some change to win32 port - use posixpath

Change History

(follow-up: ↓ 2 ) 09/10/06 04:01:54 changed by cboos

Just to be sure: you set the Trac Release to 0.9, are you using the 0.9 branch of the plugin? If so, double check the DoxygenPlugin documentation, the html_output is something new I added on the 0.10 branch.

I had the impression that support for multiple documentations was not working as it should in the 0.9 branch, therefore a lot of changes were made in the 0.10 branch, and the setup you described should work there, e.g.

your trac.ini: 

[doxygen]
path = C:
default_documentation = tl/base/doc
wiki_index = DoxyGen
html_output = html

and your DoxyGen page: 

  * [doxygen:tl/base/doc/index base]
  * [doxygen:tl/ngl/doc/index ngl]
  * [doxygen:tl/apk/doc/index apk]
  * [doxygen:tl/apk/tools/apkedit/doc/index apkedit]

Please tell me if the above works or not with 0.10, as it should. For 0.9, I'm afraid I won't be able to help...

Also, your suggestion of using multiple default documentations is interesting; I was about implementing it, but thought that maybe it would be confusing... now if other people are feeling like it would be an useful addition, I can do it.

(in reply to: ↑ 1 ; follow-up: ↓ 3 ) 09/10/06 04:30:27 changed by wadeb

  • release changed from 0.9 to 0.10.

Replying to cboos:

Just to be sure: you set the Trac Release to 0.9, are you using the 0.9 branch of the plugin? If so, double check the DoxygenPlugin documentation, the html_output is something new I added on the 0.10 branch.

You're right, I mis-flagged it as 0.9 when it should have been 0.10. Both my Trac install and DoxygenPlugin are the 0.10 versions.

I was able to get my DoxyGen? wiki page to show links with this configuration: 

[doxygen]
path = c:/
default_documentation = tl/ngl/doc
wiki_index = DoxyGen
html_output = html

and the following wiki index: 

= Online Documentation =

 * [doxygen:tl/base/doc/index Base Library Documentation] -- Documentation for the base library.
 * [doxygen:tl/ngl/doc/index NGL Documentation] -- Documentation for the NGL Graphics library.
 * [doxygen:tl/jobqueue/doc/index JobQueue Documentation] -- Documentation for the JobQueue data processing library.
 * [doxygen:tl/apk/doc/index APK Documentation] -- Documentation for the APK runtime library.
 * [doxygen:tl/apk/tools/apkedit/doc/index APKEdit Documentation] -- Documentation for the APKEdit tool library.

However, when I click the links that appear, I am redirected to this URL:

http://tltest.activision.com/trac/doxygen/tl%5Cngl%5Cdoc%5Chtml/index.html?path=c%3A%2Ftl%5Cngl%5Cdoc%5Chtml%5Cindex.html

and receive this error:

Not Found

The requested URL /trac/doxygen/tl\ngl\doc\html/index.html was not found on this server. Apache/2.0.59 (Win32) mod_python/3.2.10 Python/2.4.3 Server at tltest.activision.com Port 80

Also, your suggestion of using multiple default documentations is interesting; I was about implementing it, but thought that maybe it would be confusing... now if other people are feeling like it would be an useful addition, I can do it.

I think it would be handy for people who have as many documentation roots as I do. Maybe default_documentation could take a comma separated list, or it could be expanded to a search_locations ini entry...

Thanks for the great plugin, btw!

-Wade

(in reply to: ↑ 2 ; follow-up: ↓ 4 ) 09/10/06 04:52:56 changed by cboos

  • status changed from new to assigned.

Replying to wadeb:

... However, when I click the links that appear, I am redirected to this URL: http://tltest.activision.com/trac/doxygen/tl%5Cngl%5Cdoc%5Chtml/... and receive this error: Not Found The requested URL /trac/doxygen/tl\ngl\doc\html/index...

Ugh, this is what you get when you develop on Linux... you tend to easily forget the distinction between os.path and posix.path :)

Thanks for the detailed report, I hope I'll find some time later today to fix this.

(in reply to: ↑ 3 ) 10/04/06 11:16:19 changed by ttressieres

  • cc set to ttressieres.

Replying to cboos:

Replying to wadeb:

... However, when I click the links that appear, I am redirected to this URL: http://tltest.activision.com/trac/doxygen/tl%5Cngl%5Cdoc%5Chtml/... and receive this error: Not Found The requested URL /trac/doxygen/tl\ngl\doc\html/index...

Ugh, this is what you get when you develop on Linux... you tend to easily forget the distinction between os.path and posix.path :) Thanks for the detailed report, I hope I'll find some time later today to fix this.

There is another problem on Windows platform, you have to open the search.idx in binary mode: replace 

fd = open(index)

with 

fd = open(index, 'rb')

10/30/06 22:01:43 changed by jeffk@jdkoftinoff.com

  • keywords set to security hole.

I would like to add my 0x2c to this point... I was almost finished setting up doxygen plugin on my trac installation for my open source code at http://clicker.jdkoftinoff.com/projects/trac/jdks/

when I noticed that clicking on a [doxygen:libjdkwn/index] sent the browser to a url ending in: ....jdks/doxygen/libjdkwn/html/index.html?path=%2Fvar%2Fcache%2Fdoxygen%2Flibjdkwn%2Fhtml%2Findex.html

that really is a security hole. On your own trac/doxygen installation, try replacing ?path=.... with ?path=%2Fetc%2fpasswd .... or any other world readable file...

12/07/06 10:30:58 changed by ttressieres

  • attachment win32_port-r1251.diff added.

some change to win32 port - use posixpath

11/16/08 20:30:29 changed by Alessyvoili

  • cc changed from ttressieres to Riyadh.
  • keywords changed from security hole to MESSAGE.

to: Admin - If You want to delete your site from my spam list, please sent url of your domain to my e-mail: stop.spam.today@gmail.com And I will remove your site from my base within 24 hours webmastegz

11/17/08 15:02:48 changed by ImpulseRelp

to: Admin - If You want to delete your site from my spam list, please sent url of your domain to my emai: stop.web.spam@gmail.com And I will remove your site from my base within 24 hours webmastegz

PS. As the previous address of an e-mail has been removed also all letters on it have been lost I is compelled to make this dispatch once again. PS2. To send url your site on an e-mail stop.web.spam@gmail.com is a unique way to avoid a spam from me. To write abuses to the various "stop spam" sites - it is useless. PS3. Your addresses of an e-mail are not necessary to me, you can create an e-mail through free service and send me yours url through this e-mail PS4. sorry for my bad English :)

Add/Change #706 (scanning algorithm?)




Change Properties
Action