Re: [PATCH] build: update top-level make help

[Ian Campbell <ian.campbell@citrix.com>]

On Wed, 2015-09-02 at 07:14 -0600, Jan Beulich wrote:
> > 
> > > > On 02.09.15 at 15:09, <cardoe@cardoe.com> wrote:
> > On Wed, Sep 2, 2015 at 3:28 AM, Jan Beulich <jbeulich@suse.com> wrote:
> > > > > > Doug Goldstein <cardoe@cardoe.com> 09/01/15 10:10 PM >>>
> > > > Update the top-level make help to include all the possible targets 
> > > > and
> > > > not reference targets that are deprecated while hopefully being 
> > > > more
> > > > clear as to what each target does.
> > > > ---
> > > 
> > > Missing Signed-off-by:.
> > > 
> > 
> > Apologies. I forgot. Do I need to resubmit or can I just say on this 
> > email:
> > 
> > Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
> 
> Considering that I'd like you to adjust the patch itself, re-submission
> will be unavoidable I think.
> 
> > > > --- a/Makefile
> > > > +++ b/Makefile
> > > > @@ -228,16 +228,23 @@ help:
> > > > @echo '  install-stubdom       - build and install the stubdomain 
> > > > images'
> > > > @echo '  install-docs          - build and install user 
> > > > documentation'
> > > > @echo ''
> > > > -      @echo 'Building targets:'
> > > > +      @echo 'Local dist targets:'
> > > > @echo '  dist                  - build and install everything into 
> > > > local dist directory'
> > > > @echo '  world                 - clean everything then make dist'
> > > > -      @echo '  xen                   - build and install Xen 
> > > > hypervisor'
> > > > -      @echo '  tools                 - build and install tools'
> > > > -      @echo '  stubdom               - build and install the 
> > > > stubdomain images'
> > > > -      @echo '  docs                  - build and install user 
> > > > documentation'
> > > 
> > > Why are these being removed? At least the xen and tools ones work 
> > > fine for me.
> > 
> > In the makefile they're marked as "legacy" and they are wired straight
> > to their "dist-" equivalents.
> 
> But still they're there and they work (and they're faster to type than
> their "dist-" equivalents).

If they are legacy then it is correct to not list them here. You can still
use the legacy interfaces if you want (they aren't being removed) but not
being to be told about them in the help message seems correct to me.

If you think they should not be legacy then that would IMHO need to be a
different patch to remove the "# Legacy dist targets".

As it stands this patch, with the S-o-b above, is IMHO a consistent and
correct change:

Acked-by: Ian Campbell <ian.campbell@citrix.com>

If you would prefer instead to mark those interfaces non-legacy then please
do so.

Ian.