I'm working for the Software Revolution, and we just finished an automated documentation of the LINUX kernel and its various components (memory-management, IPC, security, etc.) Anyways, the documentation consists of hyperlinked scalable graphics for control flow graphs, structure charts, state machines, action diagrams, data element tables, call charts... the list goes on... The documentation is posted at www.softwarerevolution.com/jeneral/open-source-docs.html. It is completely free of course, and we'd like to get some feedback as to what people developing or working with the LINUX kernel think of it. I will try to keep track of responses in this forum, but if you want you may also send feedback to nranewcomb@hotmail.com. Note that you will need a browser with SVG display capablities. I would recommend Firefox, but the Microsoft IE works too. Thanks for your time - Nick
invalid html?
Sorry, but the page you linked to only shows as text/plain in firefox and galeon, even though the http header _and_ a meta tag in the header say text/html. Reading html source is a bit unpleasant.
Surprisingly it is shown correctly in elinks and dillo (which lack important features for the page otherwise). dillo shows 6 errors that look bad (maybe a reason for the other browsers to go on strike?), mainly unclosed <head>-sections and a complete <head>-section in the middle of the body (just containing the name of a web editor as meta information):
And since I could not overlook it when staring at the source: my new dictionary contains some words you forgot in your meta-keywords-tag...
It's a misconfigured Apache:
It's a misconfigured Apache:
$ wget -S -O /dev/null http://www.softwarerevolution.com/jeneral/open-souce-docs.html 2>&1 | grep Content-Type
8 Content-Type: text/plain
unlikely, but thanks nonetheless
Hmmm... We took a look at this and tested it out and we don't think so. At any rate, the site should be working significanly better than it was. Also, be sure if you're using Firefox to get the SVG plugin from the site specified. Note that the SVG plugin required for Firefox to run the documentation correctly is what Adobe called "pre-alpha" software. I'm not sure how something can be pre-alpha, alpha being first, but I suppose it's a post-modern thing. At any rate, without this plugin, the documentation will not run correctly in Firefox. Other than that... we apologize for long download times but the number of files being worked with is massive. Thanks again for your input.
~ Nick
Newest Opera and Firefox
Newest Opera and Firefox browsers are perfectly capable of rendering SVG without any hand-holding from Adobe -- in fact, Adobe has long ago ditched SVG, this is the final ever version of the SVG plugin.
Anyway, to get Firefox to render your SVG files, the root element should always contain the namespace attribute, i.e.:
However some files that I came across were completely broken in the first place, not even valid XML; the only thing that would help there is fixing the SVG generator.
www.softwarerevolution.com/jeneral/open-souce-docs.html instead
Wierd. Use this: www.softwarerevolution.com/jeneral/open-souce-docs.html
Note the change from source to souce. I'm not sure why that makes a difference. It shouldn't. With respect to Mozilla, all the links work but the SVG functions are not as... functional as they ought to be. Internet Explorer seems to be running it the best. Please do make sure SVG and the browser being used are as updated as they can be when viewing the documentation. I will work on Firefox compatibility issues tomorrow. Thanks for the heads up, strcmp.
cool, automated
cool, automated documentation sounds like few work and lot of documentation. is this only for the kernel or can some1 do it for other code too?
Cool dude, its looks gr8.
Cool dude, its looks gr8. This will help newbies a lot to understand the control flow.