Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 376319

Summary: [console] help - consider allowing for scope to be specfied
Product: [Eclipse Project] Equinox Reporter: Thomas Watson <tjwatson>
Component: ComponentsAssignee: Lazar Kirchev <l.kirchev>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P3 Flags: tjwatson: review+
Version: 3.8.0 Juno   
Target Milestone: Juno M7   
Hardware: PC   
OS: Mac OS X - Carbon (unsup.)   
Whiteboard:
Attachments:
Description Flags
Patch for filtering commands according to scope
none
Documentation for the -scope argument none

Description Thomas Watson CLA 2012-04-09 09:16:04 EDT
In bug362311 a fix has been released to provide a better help command.  It may be worth it to add an option to specify a scope for the help command.  Currently if nothing is specified then all scopes get listed which can be very long.
Comment 1 Thomas Watson CLA 2012-04-09 09:17:17 EDT
This is a nice to have in my opinion.  Marking for Juno as a possible polish item.
Comment 2 Lazar Kirchev CLA 2012-04-09 10:33:10 EDT
(In reply to comment #1)
> This is a nice to have in my opinion.  Marking for Juno as a possible polish
> item.

I was thinking for something similar, but I hit some technical difficulties with the filtering. I will try to find some solution.
Comment 3 Thomas Watson CLA 2012-04-25 11:21:54 EDT
If this is going to happen it needs to happen this week.  M7 is next week.  Otherwise we should defer.
Comment 4 Lazar Kirchev CLA 2012-04-27 06:26:50 EDT
(In reply to comment #3)
> If this is going to happen it needs to happen this week.  M7 is next week. 
> Otherwise we should defer.

I was thinking to work on shell items April 28th - May 1st. I think this is still before M7 build? Integration builds is on May 1st, right? I will try to have this fixed before May 1st.
Comment 5 Thomas Watson CLA 2012-04-27 08:39:22 EDT
(In reply to comment #4)
> (In reply to comment #3)
> > If this is going to happen it needs to happen this week.  M7 is next week. 
> > Otherwise we should defer.
> 
> I was thinking to work on shell items April 28th - May 1st. I think this is
> still before M7 build? Integration builds is on May 1st, right? I will try to
> have this fixed before May 1st.

Yes, next week is our milestone week.  We should target to have everything done by Tuesday May 1st.  See the build schedule at http://www.eclipse.org/eclipse/platform-releng/buildSchedule.html

We don't want to do anything too risky at this point that could risk getting a stable build next week.  So please use caution and don't hesitate to have someone review the fix if you have doubts.
Comment 6 Lazar Kirchev CLA 2012-04-27 10:38:21 EDT
(In reply to comment #5)
> (In reply to comment #4)
> > (In reply to comment #3)
> > > If this is going to happen it needs to happen this week.  M7 is next week. 
> > > Otherwise we should defer.
> > 
> > I was thinking to work on shell items April 28th - May 1st. I think this is
> > still before M7 build? Integration builds is on May 1st, right? I will try to
> > have this fixed before May 1st.
> 
> Yes, next week is our milestone week.  We should target to have everything done
> by Tuesday May 1st.  See the build schedule at
> http://www.eclipse.org/eclipse/platform-releng/buildSchedule.html
> 
> We don't want to do anything too risky at this point that could risk getting a
> stable build next week.  So please use caution and don't hesitate to have
> someone review the fix if you have doubts.

Sure, Tom. I don't think this enhancement could be risky, but I will definitely request review.
Comment 7 Lazar Kirchev CLA 2012-04-30 06:41:10 EDT
Created attachment 214791 [details]
Patch for filtering commands according to scope

This fix adds a -scope option to the help command to allow help to be displayed only for commands with specified scope.

Tom, would you like to have a look on the patch before I submit it?
Comment 8 Lazar Kirchev CLA 2012-04-30 08:07:07 EDT
Created attachment 214795 [details]
Documentation for the -scope argument

This patch provides documentation for the -scope feature.
Comment 9 Thomas Watson CLA 2012-04-30 09:28:53 EDT
(In reply to comment #7)
> Created attachment 214791 [details]
> Patch for filtering commands according to scope
> 
> This fix adds a -scope option to the help command to allow help to be displayed
> only for commands with specified scope.
> 
> Tom, would you like to have a look on the patch before I submit it?

+1 to this patch.  I will release the help once you have committed this patch.
Comment 10 Lazar Kirchev CLA 2012-04-30 09:59:35 EDT
(In reply to comment #9)
> (In reply to comment #7)
> > Created attachment 214791 [details]
> > Patch for filtering commands according to scope
> > 
> > This fix adds a -scope option to the help command to allow help to be displayed
> > only for commands with specified scope.
> > 
> > Tom, would you like to have a look on the patch before I submit it?
> 
> +1 to this patch.  I will release the help once you have committed this patch.

Submitted with commit http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=7083fe1e6a1f8e2c3cdc167c0ca58a04b010d462