Generate make helping message dynamicaly.

[4383]

Summarize

Generate make helping message dynamicaly by using
python code snippet inside Makefile.

All commented make targets will be added to the
help message. To be added to the helping message
comment need to start with '## '.

These specials comments are detected by the python code.
Python code generate the helping output from these results.

Notice that this commit introduce a dependency with python (compatible python 2 and 3).

Signed-off-by: Hervé Beraud hberaud@redhat.com

Sample output

My changes generate the following outputs:

$ make help                                                                                                                          
Usage: make <target>                                                                                                                                                                                                 
 * 'binaries' - Build podman                                                                                                                                                                                         
 * 'changelog' - Generate changelog                                                                                                                                                                                  
 * 'clean' - Clean artifacts                                                                                                                                                                                         
 * 'docs' - Generate documentation                                                                                                                                                                                   
 * 'gofmt' - Verify the source code gofmt                                                                                                                                                                            
 * 'install' - Install binaries to system locations                                                                                                                                                                  
 * 'integration' - Execute integration tests                                                                                                                                                                         
 * 'libpodimage' - Build the libpod image                                                                                                                                                                            
 * 'lint' - Execute the source code linter                                                                                                                                                                           
 * 'local-cross' - Cross local compilation                                                                                                                                                                           
 * 'perftest' - Build perf tests                                                                                                                                                                                     
 * 'podman' - Build with podman                                                                                                                                                                                      
 * 'podman-remote' - Build with podman on remote environment                                                                                                                                                         
 * 'podman-remote-darwin' - Build with podman on remote OSX environment                                                                                                                                              
 * 'run-perftest' - Build and run perf tests                                                                                                                                                                         
 * 'shell' - Run the builted image and attach a shell                                                                                                                                                                
 * 'test' - Run tests on builted image                                                                                                                                                                               
 * 'testunit' - Run unittest on the builted image     

You can test them by using the following commands:

$ git clone https://github.com/4383/libpod -b improve-makefile
$ cd libpod
$ make help # generate the previous output
...

Warning

• These changes introduce a dependency with python 2 or 3.
• I doesn't comment all targets due to a lack of knowledge about them. Feel free to ask to me to complet these comments with your knowledges about them.

Cheers!

[4383]

/assign @rhatdan

[rh-atomic-bot]

Can one of the admins verify this patch?
I understand the following commands:

• bot, add author to whitelist
• bot, test pull request
• bot, test pull request once

[openshift-ci-robot]

@4383: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/assign @rhatdan

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[rhatdan]

bot, add author to whitelist
LGTM
@mheon @baude @umohnani8 @giuseppe @vrothberg @TomSweeneyRedHat PTAL

[TomSweeneyRedHat]

/approve

[TomSweeneyRedHat]

s/buillted/built/

[TomSweeneyRedHat]

s/builted/built/

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 4383, TomSweeneyRedHat

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [TomSweeneyRedHat]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[TomSweeneyRedHat]

s/builted/built/

[TomSweeneyRedHat]

@4383 thanks for the PR. I like the look/feel of this, thanks for posting the PR. I found a few nits that I commented on. The python dependency I'm a little cautious on, but good to hear it works with python 2 or 3. I think adding a python dependency is OK, but I'll let others weigh in on that.

[4383]

@TomSweeneyRedHat nits fixed! :)

[openshift-ci-robot]

@4383: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

@TomSweeneyRedHat nits fixed! :)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[TomSweeneyRedHat]

LGTM, assuming happy tests and the Python dependency being hip with others.

[rhatdan]

/lgtm
Thanks @4383