Document the generic `make' targets.

`make help' mentions that `default' is the same as the empty target, but it's not quite true: it doesn't recurse through directories. Update `make help', to correctly document the generic targets.

[dak, 2013-09-06 16:39:24]

https://codereview.appspot.com/13290047/diff/1/stepmake/stepmake/generic-targ...
File stepmake/stepmake/generic-targets.make (right):

https://codereview.appspot.com/13290047/diff/1/stepmake/stepmake/generic-targ...
stepmake/stepmake/generic-targets.make:1: .PHONY : all clean bin-clean default
dist exe help html lib man TAGS\
That change might be independently useful.

https://codereview.appspot.com/13290047/diff/1/stepmake/stepmake/generic-targ...
stepmake/stepmake/generic-targets.make:5: default: all
I have no idea what makes you think that default is not a defined target for
most Makefiles.

git grep "^default:"

turns up a host of default targets.

Documentation/GNUmakefile:default: local-txt-doc
Documentation/css/GNUmakefile:default:
Documentation/logo/GNUmakefile:default: $(lilypond-icon) $(ly-icon)
Documentation/misc/GNUmakefile:default: local-txt-doc
Documentation/pictures/GNUmakefile:default:
GNUmakefile.in:default: $(config_h) build-dir-setup build-scripts
lily/GNUmakefile:default:
make/abc-targets.make:default:
make/doc-i18n-root-targets.make:default:
make/lilypond-book-targets.make:default:
make/midi-targets.make:default:
make/musicxml-targets.make:default:
mf/GNUmakefile:default: $(ALL_GEN_FILES) \
po/GNUmakefile:default: $(MO_FILES)
python/GNUmakefile:default: $(outdir)/relocate-preamble.py
python/auxiliar/GNUmakefile:default:
stepmake/stepmake/automatically-generated.sub.make:default:
stepmake/stepmake/documentation-targets.make:default:
stepmake/stepmake/executable-targets.make:default: $(EXECUTABLE)
stepmake/stepmake/help2man-targets.make:default: man
stepmake/stepmake/library-targets.make:default: $(LIBRARY)
stepmake/stepmake/python-module-targets.make:default: $(OUT_PY_MODULES) $(OUT_PY
stepmake/stepmake/shared-library-targets.make:default: $(SHARED_LIBRARY)
stepmake/stepmake/texinfo-targets.make:default: $(INFO_FILES)
stepmake/stepmake/topdocs-targets.make:default: local-txt-doc

So you should likely check which particular Makefile is missing a default target
and double-check by trying "make default" since there are a lot of opportunities
for having the default target defined in an include file.

[Julien Rioux, 2013-09-06 19:37:25]

On 2013/09/06 16:39:24, dak wrote:
>
https://codereview.appspot.com/13290047/diff/1/stepmake/stepmake/generic-targ...
> File stepmake/stepmake/generic-targets.make (right):
> 
>
https://codereview.appspot.com/13290047/diff/1/stepmake/stepmake/generic-targ...
> stepmake/stepmake/generic-targets.make:1: .PHONY : all clean bin-clean default
> dist exe help html lib man TAGS\
> That change might be independently useful.
> 
>
https://codereview.appspot.com/13290047/diff/1/stepmake/stepmake/generic-targ...
> stepmake/stepmake/generic-targets.make:5: default: all
> I have no idea what makes you think that default is not a defined target for
> most Makefiles.
> 
> git grep "^default:"
> 
> turns up a host of default targets.
> 
> Documentation/GNUmakefile:default: local-txt-doc
> Documentation/css/GNUmakefile:default:
> Documentation/logo/GNUmakefile:default: $(lilypond-icon) $(ly-icon)
> Documentation/misc/GNUmakefile:default: local-txt-doc
> Documentation/pictures/GNUmakefile:default:
> GNUmakefile.in:default: $(config_h) build-dir-setup build-scripts
> lily/GNUmakefile:default:
> make/abc-targets.make:default:
> make/doc-i18n-root-targets.make:default:
> make/lilypond-book-targets.make:default:
> make/midi-targets.make:default:
> make/musicxml-targets.make:default:
> mf/GNUmakefile:default: $(ALL_GEN_FILES) \
> po/GNUmakefile:default: $(MO_FILES)
> python/GNUmakefile:default: $(outdir)/relocate-preamble.py
> python/auxiliar/GNUmakefile:default:
> stepmake/stepmake/automatically-generated.sub.make:default:
> stepmake/stepmake/documentation-targets.make:default:
> stepmake/stepmake/executable-targets.make:default: $(EXECUTABLE)
> stepmake/stepmake/help2man-targets.make:default: man
> stepmake/stepmake/library-targets.make:default: $(LIBRARY)
> stepmake/stepmake/python-module-targets.make:default: $(OUT_PY_MODULES)
$(OUT_PY
> stepmake/stepmake/shared-library-targets.make:default: $(SHARED_LIBRARY)
> stepmake/stepmake/texinfo-targets.make:default: $(INFO_FILES)
> stepmake/stepmake/topdocs-targets.make:default: local-txt-doc
> 
> So you should likely check which particular Makefile is missing a default
target
> and double-check by trying "make default" since there are a lot of
opportunities
> for having the default target defined in an include file.

I was confused. default exists, it's just not what I expected after reading the
description: the empty target is equivalent to `make all' (which recurses
through all subdirectories) and not `make default' (which acts in the local
directory only). I'll turn this issue into a documentation one, changing what
`make help' has to say about the default target.

Cheers,
Julien

[Julien Rioux, 2013-09-11 09:49:00]

Revert previous change. Document the default target instead.

[Julien Rioux, 2013-09-11 09:59:36]

Updated to be purely documentational.

[Mark Polesky, 2013-09-11 18:54:01]

https://codereview.appspot.com/13290047/diff/5001/stepmake/stepmake/generic-t...
File stepmake/stepmake/generic-targets.make (right):

https://codereview.appspot.com/13290047/diff/5001/stepmake/stepmake/generic-t...
stepmake/stepmake/generic-targets.make:56: @echo "  default      same as the
empty target, restricted to current directory"
personally, I would find this wording more intuitive:

  same as `make all', but restricted to the current directory

Although... I guess `make local-all' and `make default' do the same thing? 
Maybe you could just say

  same as `make local-all'

These are just some ideas; I'll let you and the others decide if you want to
change anything at all.

- Mark

[Julien Rioux, 2013-09-11 19:11:40]

On 2013/09/11 18:54:01, Mark Polesky wrote:
> personally, I would find this wording more intuitive:
> 
>   same as `make all', but restricted to the current directory
> 

Sounds good.

> Although... I guess `make local-all' and `make default' do the same thing? 
> Maybe you could just say
> 
>   same as `make local-all'
> 

There isn't a local-all target (although `make help' hints that there should
be). hmm, should probably corrcet this as well.

Cheers,
Julien

[Julien Rioux, 2013-09-12 16:15:02]

Respond to review: tweak wording, add local-all target.

[janek, 2013-09-15 19:06:24]

LGTM.