Re: make help

[Sheldon Gill]

Nicola Pero wrote:
> I was thinking of adding a little bit of inline help for gnustep-make.
> What's the best way ?  I was thinking of adding a target like
>
> $> make help
> This is gnustep-make 1.13.0.
>
> Most common targets:
>  make all (builds)
>  make install (installs)
>  make uninstall (uninstalls)
>  make clean (deletes built files)
>  make distclean (deletes all built files)
>  make dist (creates a .tar.gz of the software sources)
>
> Most common options that can be used with any of the targets:
>  debug=no (turns off generation of debug symbols)
>  strip=yes (strips executables and objects before installing)
>  shared=no (builds static executable and objects)
>  messages=yes (prints verbosely all commands being executed)
>  GNUSTEP_INSTALLATION_DIR=/usr/GNUstep/System (installs in the specified dir)
>
> $>

I'm all for adding more documentation and help...

but...

please *don't* make it a target!

$> make help

is used to generate application help files.


> Anyone has got a better idea ?

The obvious one would be --help but that'd invoke 'make's own, of course ;)

Here are some other ideas you could use:

 info
 helpme
 summary
 options
 gnustep-make-help
 shortform

or make it an option

 info=yes
 summary=yes
 shortform=yes




Regards,
Sheldon