| Summary: | Re-take Helgrind screenshots with fixed Valgrind error markers | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Product: | [Tools] Linux Tools | Reporter: | Andrew Overholt <overholt> | ||||||||||
| Component: | Valgrind | Assignee: | Daniel Henrique Barboza <danielhb> | ||||||||||
| Status: | CLOSED FIXED | QA Contact: | |||||||||||
| Severity: | normal | ||||||||||||
| Priority: | P3 | CC: | akurtakov, ebaron, wainersm | ||||||||||
| Version: | unspecified | ||||||||||||
| Target Milestone: | --- | ||||||||||||
| Hardware: | PC | ||||||||||||
| OS: | Linux | ||||||||||||
| Whiteboard: | |||||||||||||
| Attachments: |
|
||||||||||||
|
Description
Andrew Overholt
Hi, I've pulled the latest changes from master branch, took new screenshots but the Valgrind error icon remained the same one that appears in the screenshots of http://wiki.eclipse.org/Linux_Tools_Project/Valgrind/User_Guide#Using_Helgrind . To pull from master I did, in my local master (this is a github tree): $ git fetch upstream $ git merge upstream/master Is there something I'm missing or doing wrong? I've never worked with a clone that wasn't from git.eclipse.org but what you did _appears_ correct. Could you try with a clone from the canonical repo? Hi Andrew, Just tried with the repo from git://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git and the Valgrind error marker I'm seeing is the same as the one that's on the current screenshots ( a red V with a small red X on the bottom right). I can update the screenshot, but it would be the same thing and you wouldn't even notice :) Created attachment 209085 [details]
new icons in screenshot
The icons are essentially the same but they don't have jagged edges nor do they get cut off in the margin next to the editor. This screenshot shows what I mean. I'll take another one before Elliott's fix and you'll see the difference.
Created attachment 209086 [details]
screenshot of previous behaviour
Created attachment 209087 [details]
helgrind output screeenshot
This is the screenshot with the current master branch from git.eclipse.org.
Is it the new icons?
(In reply to comment #6) > Created attachment 209087 [details] > helgrind output screeenshot > > This is the screenshot with the current master branch from git.eclipse.org. > > Is it the new icons? Yes :) Ok :) I've updated the wiki page http://wiki.eclipse.org/Linux_Tools_Project/Valgrind/User_Guide#Analyzing_Helgrind_Profile_Results with the screenshot I've attached to this bug. Let me know if this will suffice. This looks good. Can you re-generate the HTML like Elliott did in bug 367373? Sure, just tell me how or point me to a direction, because I have no idea how to do that :) Checking on bug 367373 I've seen that there is something to do with Mylyn, but I didn't learn much more than that. The HTML is actually generated by Mylyn's WikiText plugins: http://wiki.eclipse.org/Mylyn/WikiText There's a build-helper.xml file in org.eclipse.linuxtools.valgrind.doc that can be used to generate the HTML. It will also grab the images. It'll require a modification to the location of an Eclipse binary (you'll see a reference to /home/elliott right now). You'll likely also have to modify the Valgrind user guide wiki page temporarily due to bug 367525 (just look in the history of the wiki page to see what Elliott did). Thanks! P.S. I filed bug 367968 to remember to document how we use WikiText for generating the HTML. Hi, I took some time to get this task done but I'm seeing some updates going on at the bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=367525 . Do I still need to comment the templates information like described or another (better) solution is already on the way? Hi, (In reply to comment #12) > I took some time to get this task done but I'm seeing some updates going on at > the bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=367525 . Do I still need > to comment the templates information like described or another (better) > solution is already on the way? It's probably easiest to just comment, re-generate, then, un-comment. Once the WikiText situation is sorted out we can go from there. Thanks, Daniel! Created attachment 209458 [details]
Patch that updates the doc plug-in
I think I've managed to re-generate the html from the wiki. I've checked the file and it looks exact the same as the wiki, but another eye can be useful because I have a hard time to distinguish the old and new icons :)
I would like also to comment the steps I took, maybe it's feasible to add them somewhere:
- installed Mylyn/WikiText for Eclipse
- copied org.eclipse.linuxtools.valgrind.doc/build-helper.xml to org.eclipse.linuxtools.valgrind.doc/build.xml
- edited build.xml paths to match my system
- installed ant and ant-nodeps via YUM:
$ yum install ant
$ yum install ant-nodeps
- removed the comment from the wikipage as described in the comments above
- executed "ant" inside org.eclipse.linuxtools.valgrind.doc dir
Thanks
(In reply to comment #14) > Created attachment 209458 [details] > Patch that updates the doc plug-in > > I think I've managed to re-generate the html from the wiki. I've checked the > file and it looks exact the same as the wiki, but another eye can be useful > because I have a hard time to distinguish the old and new icons :) All I can see is that the image path has changed. But HelgrindOutput2.png definitely has the new icons so I think we're good to go as long as that image is brought in with your wikitext update as well. > I would like also to comment the steps I took, maybe it's feasible to add them > somewhere: Yes, please add a small page under the Linux_Tools_Project wiki hierarchy and link to it from here: http://wiki.eclipse.org/Linux_Tools_Project/Contributor_Guide > - installed Mylyn/WikiText for Eclipse > > - copied org.eclipse.linuxtools.valgrind.doc/build-helper.xml to > org.eclipse.linuxtools.valgrind.doc/build.xml What about just editing build-helper.xml directly and running it with Eclipse's built-in ant runner (right-click -> Run As -> Ant build)? Yeah, running from Eclipse didn't cross my mind when I was doing it ... I guess it's simpler than what I've done :) I've created a wikipage describing this process ( http://wiki.eclipse.org/Linux_Tools_Project/Building_Valgrind_Doc ) and added references to it in the Getting Involved and in the Contributor Guide. I've also mentioned at https://bugs.eclipse.org/bugs/show_bug.cgi?id=367525 that this page I've created needs update when this bug gets solved. I guess this bug is fixed. Can anyone check and close it (if it's the case) ? (In reply to comment #17) > I guess this bug is fixed. Can anyone check and close it (if it's the case) ? I don't see any update to valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images/HelgrindOutput.png since e5af7404c983ec8350a3ac2ab15173b774457347: http://git.eclipse.org/c/linuxtools/org.eclipse.linuxtools.git/log/valgrind/org.eclipse.linuxtools.valgrind.doc/Linux_Tools_Project/Valgrind/User_Guide/images So it still has the old jagged icons. Be sure that file is over-written when you re-generate and that it's "git add"'d before you commit. |