Bugzilla – Full Text Bug Listing
| Summary: | SystemTap Help formatting doesn't conform to the rest of the Eclipse Help. | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Tools] Linux Tools | Reporter: | Corey Ashford <cjashfor> | ||||
| Component: | Systemtap | Assignee: | anithra <anithra> | ||||
| Status: | CLOSED FIXED | QA Contact: | |||||
| Severity: | normal | ||||||
| Priority: | P3 | CC: | obusatto | ||||
| Version: | unspecified | ||||||
| Target Milestone: | 0.10.0 | ||||||
| Hardware: | All | ||||||
| OS: | Linux | ||||||
| Whiteboard: | |||||||
| Attachments: |
|
||||||
|
Description
Corey Ashford
After a discussion with Andrew Overholt, he pointed me at the fact that most of the Linux Tools Project help pages are built automatically from Wiki pages. However, most of the SystemTap documentation is not yet derived from Wiki pages. The long term goal should be to consolidate all of the SystemTap help onto Wikis where they can be edited "easily", and then automatically built into the periodic releases. Created attachment 198208 [details]
Cleans up existing SystemTap docs in place
There are additional comments in the patch itself, but basically it fixes
the existing HTML errors, reformats the help files into compliant XHTML, fixes
a few spellos, and hooks the pages up to a CSS file as is used for the other
Linux Tools Project help files.
This should be considered just a first step to transferring the HTML over to the wiki.
Thanks for the patch, Corey.
How should I apply it? First off I tried Mylyn's Apply Path but that didn't work. Then I tried git am and it failed. Finally I tried git apply and it gave this output:
$ git apply /tmp/test.patch
/tmp/test.patch:45: trailing whitespace.
h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 }
/tmp/test.patch:58: trailing whitespace.
li { margin-top: 0; margin-bottom: 0 }
/tmp/test.patch:59: trailing whitespace.
li p { margin-top: 0; margin-bottom: 0 }
/tmp/test.patch:67: trailing whitespace.
div.revision { border-left-style: solid; border-left-width: thin;
/tmp/test.patch:73: trailing whitespace.
.guitab, .important, .guibutton, .selectblue, .guimenu, .guilabel,
warning: squelched 17 whitespace errors
warning: 22 lines add whitespace errors.
I'm thinking it might be easier to do something like is outlined here:
http://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions
Since it's > 250 lines I'll have to open a CQ but I'll wait for your thoughts on the above before doing so. Thanks again!
Andrew, Somehow I missed that you had commented on this patch. My apologies for not responding earlier. If there are only whitespace errors, I can clean those up. I'm using hyper-careful with trailing space, so I'm guessing those white space errors were in the original docs, and when I made some minor changes, I didn't remove the existing trailing whitespace. Does the 250-line limitation apply to a patch that only contains documentation? In fact, the patch does not change the content of the documentation, just the formatting. For future patches, I can create a github site for sharing commits. Let me know which route you want to go. If you can get an IBMer (Anithra) to apply your patch, the 250 line limit doesn't apply (since she's also at IBM). It's technically "the entire patch" ... github or any publicly available git repo is perfect. Thanks. Is this patch ok?(In reply to comment #5) > If you can get an IBMer (Anithra) to apply your patch, the 250 line limit > doesn't apply (since she's also at IBM). It's technically "the entire patch" > ... > > github or any publicly available git repo is perfect. Thanks. I can apply it. Is this patch ready to go? (In reply to comment #6) > Is this patch ok?(In reply to comment #5) > > If you can get an IBMer (Anithra) to apply your patch, the 250 line limit > > doesn't apply (since she's also at IBM). It's technically "the entire patch" > > ... > > > > github or any publicly available git repo is perfect. Thanks. > > I can apply it. Is this patch ready to go? Try taking the patch and apply it to the current docs. You may have to fix some whitespace issues. After you do that, it might be a good idea to get all of the Systemtap docs out into the wiki so that they can be maintained in a better way than just a bunch of hand-edited html files. Yes, I'd prefer the docs to be wiki pages so they're consistent. Corey's patch was committed. I'll work on moving the doc to wiki later. Is there a script to easily generate the html from the wiki pages? (In reply to comment #9) > Corey's patch was committed. I'll work on moving the doc to wiki later. Is > there a script to easily generate the html from the wiki pages? I found this page. This may help. http://wiki.eclipse.org/Linux_Tools_Project/Building_Valgrind_Doc Feel free to make a general "Building Linux Tools MediaWiki-based Documentation Plugins" page, Otavio :) I haven't tried the following, but it might be worth a shot: http://www.mediawiki.org/wiki/Manual:Importing_external_content#Converting_content_from_HTML_text_file All wiki content was updated now using the mediawiki format. I generated the html from the wiki and committed that in commit 22d5b8f9a6461335160a2406302593d6f9f69344. I left some orphan pages in the wiki. I need to figure out an easy way of removing it. We still needs to remove all 'static' documentation that are still spread all over systemtap plugins Duplication removed and mediawiki-based documentation updated upstream. Verified in 0.10 release. |