Community
Participate
Working Groups
Build Identifier: 20110615-0604 In the help : Workbench User Guide > Getting started > Basic tutorial > Comparing Just below the first screen grab : 1. The buttons in the small screen grab are not the good ones 2. The tool tips in the GUI display "Next/Previous difference", not "Next/Previous change", as explained in the doc. Reproducible: Always
Created attachment 204022 [details] Image to add to org.eclipse.platform.doc.user\images
Created attachment 204023 [details] Changes in doc I uploaded a new image and moved the existing image to the next section where I believe it belongs. I updated the proposed actions, I suppose current version is wrongly updated legacy from times where there were only two buttons: previous/next difference, and clicking them second time moved us to the next change.
Created attachment 204164 [details] compare editor for the patch vs HEAD Couple of things I observed when reviewing the patch: * The sentence "Move to the next or previous change using the right group of local toolbar buttons." could also mention about browsing thru diffs. * Next/Prev change button will select the whole diff when moving to it. Pressing the button again will then select a change. * I've just realized that "Copy current change from left to right." should actually say "difference" to be consequent. * It looks that the compare editor doesn't shows changes for the second diff (hunk) from your patch (see screenshot).
Created attachment 204362 [details] Changes in doc I applied your suggestions to the patch. > It looks that the compare editor doesn't shows changes for the second diff (hunk) from your patch (see screenshot). This is I think type-specific or context releated. I think it needs a separate bug to investigate.
(In reply to comment #4) > I applied your suggestions to the patch. "Click the Select Next Difference button again. Observe how it selects the first change in this difference." This is not true. It's the "Select Next Change" button that selects the diff first and then selects a change. "Select Next Difference" always selects a diff. I would limit the number of bullets to 4 as this is how many actions there are in the toolbar. > I think it needs a separate bug to investigate. Agreed, have you filed a bug for it? I would check first if it's not a dupe. We have a nice set of reproducible steps here. (In reply to comment #3) > I've just realized that "Copy current change from left to right." should actually say "difference" to be consequent. This should be a separate bug as well. You cannot say "Copy current difference from left to right." in the doc when the tooltip says something different. They should changed at the same time.
Created attachment 204501 [details] Changes in doc (In reply to comment #5) > "Click the Select Next Difference button again. Observe how it selects the first > change in this difference." > > This is not true. It's the "Select Next Change" button that selects the diff > first and then selects a change. "Select Next Difference" always selects a diff. Right I corrected it. > I would limit the number of bullets to 4 as this is how many actions there are > in the toolbar. Why? "Select Next Change" behaves differently when clicked for the first and second time. > > I think it needs a separate bug to investigate. > > Agreed, have you filed a bug for it? I would check first if it's not a dupe. We > have a nice set of reproducible steps here. Can you give me your steps? I've been unable to reproduce it both from "Import patch" and "Compare with HEAD". > (In reply to comment #3) > > I've just realized that "Copy current change from left to right." should > actually say "difference" to be consequent. > > This should be a separate bug as well. You cannot say "Copy current difference > from left to right." in the doc when the tooltip says something different. They > should changed at the same time. Actually none of us was right about that. The documentation is correct. When there's a changed selected at the time "Copy current change..." is clicked only the selected change is copied. The whole difference is copied only if no change is selected. Based on this "Copy current change..." is I think better than "Copy current difference...", but still not ideal. Maybe it should say "Copy selected difference/change from left to right"?
(In reply to comment #6) > "Select Next Change" behaves differently when clicked for the first and second time. Right, but that's true for "Select Previous Change" as well, which you didn't describe in a separate bullet. > Can you give me your steps? I've been unable to reproduce it both from "Import > patch" and "Compare with HEAD". That's funny, I'm not able to reproduce it either. I thought all you need to do is apply your patch and then go to the Sync view. I noticed the missing decorations in the latter. It works fine now. > Maybe it should say "Copy selected difference/change from left to right"? What about "Copy Selection from Left to Right"? I guess we can leave it as it is.
(In reply to comment #7) > (In reply to comment #6) > > "Select Next Change" behaves differently when clicked for the first and second > time. What I have in mind is something like that: 1. Use the "Select Next Difference" button to navigate through differences. 2. Use the "Select Next Change" button to navigate through changes. When all changes in a difference have been visited, clicking the button will select the next difference. Click the button again to select the next change. 3. Use the "Select Prev Difference" button to navigate back through differences. 4. Use the "Select Prev Change" button to navigate back through changes. Again, clicking the button subsequently selects differences first and then the contained changes.
Created attachment 204761 [details] Changes in doc I've broaden the action descriptions from my previous patch. From our offline discussion: your propositions are good, but more for a reference guide not for the tutorial that we are editing now. See ref-25.html, it describes in details each of those actions.
Point taken, the ref page is definitely a better place for this kind of description. However, if steps from your latest patch are for the user to show her what she can do with the editor, I'm not sure how to achieve this: ... 2. Click the Select Next Change button. Observe how it selects the first change in this difference. 3. Click the Select Next Change button again. Observe how it selects the next change. ... I guess "Observe how it selects the next change." in 3. should read "Observe how it selects the next difference." Assuming the steps refer to the comparison above. Of course, you can argue here saying that in this case difference == change, but imo this is still confusing. PS. Please leave the formatting as it is. It's not perfect, but it's easier to track content changes that way.
Created attachment 204871 [details] Changes in doc
Applied to HEAD. Thanks Gosia.
