vmware-archive / dispatch

Dispatch is a framework for deploying and managing serverless style applications.
http://dispatchframework.io
Apache License 2.0
532 stars 58 forks source link

Improve make help output #694

Closed zjs closed 5 years ago

zjs commented 5 years ago

Document some key make targets, format help output more consistently, and print targets in the order they appear (instead of alphabetically) so that related targets are grouped in the output.


Before

$ make help 
check-all                      check if the source files comply to the formatting rules
checkfmt                       check formatting of source files
check                          check if the source files comply to the formatting rules
checklint                      check lint of source files
clean                          Clean all compiled files
difffmt                        diplay formatting changes that would be made by fix
distclean                      Clean ALL files including ignored ones
fix-headers                    fix copyright headers if they are missing
fmt                            format go source code
gen-clean                      Clean all files created with make generate
generate                       run go generate
help                           Display make help
run-dev                        run the dev server
swagger-validate               validate the swagger spec
test                           run tests

After

$ make help
all                            Build server and client binaries for all platforms
check                          Check if the source files comply to the formatting rules
check-all                      Check if the source files comply to the formatting rules
fmt                            Format go source code
difffmt                        Diplay formatting changes that would be made by fmt
fix-headers                    Fix copyright headers if they are missing
checkfmt                       Check formatting of source files
checklint                      Check lint of source files
swagger-validate               Validate the swagger spec
test                           Run tests
run-dev                        Run the dev server
linux                          Build linux server and client binaries
darwin                         Build darwin server and client binaries
generate                       Run go generate
gen-clean                      Clean all files created with make generate
distclean                      Clean ALL files including ignored ones
clean                          Clean all compiled files
help                           Display make help