Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: enable make help for the top level makefile #12774

Merged
merged 3 commits into from
Apr 6, 2020
Merged

Conversation

v1v
Copy link
Member

@v1v v1v commented Jul 3, 2019

Highlights

  • This is an adhoc implementation to support the make help target for the top level Makefile.
  • There is already a python script to allow to do something similar but it seems it does not support the current docs in the toplevel Makefile.
    help: ## @help Show this help.
    @python ${ES_BEATS}/libbeat/scripts/generate_makefile_doc.py $(MAKEFILE_LIST)
    help_variables: ## @help Show Makefile customizable variables.
    @python ${ES_BEATS}/libbeat/scripts/generate_makefile_doc.py --variables $(MAKEFILE_LIST)

Tasks

  • Agree whether this is a valid use case

Output

make help
Usage: make [target] [VARIABLE=value]
Targets:
  help                       Show this help.
  testsuite                  Runs complete testsuites (unit, system, integration) for all beats with coverage and race detection. Also it builds the docs and the generators.
  setup-commit-hook          Setup the git pre-commit hook
  stop-environments          Stop the environment for each project.
  test                       Runs unit and system tests without coverage and race detection.
  unit                       Runs unit tests without coverage and race detection.
  crosscompile               Crosscompile all beats.
  coverage-report            Generates coverage report.
  update                     TBD.
  clean                      Clean target.
  clean-vendor               Cleans up the vendor directory from unnecessary files. This should always be run after updating the dependencies
  check                      TBD.
  check-headers              Check the license headers.
  add-headers                Adds the license headers.
  misspell                   Corrects spelling errors.
  fmt                        TBD.
  lint                       TBD.
  docs                       Builds the documents for each beat
  notice                     Generates the NOTICE file.
  python-env                 Sets up the virtual python environment.
  test-apm                   Tests if apm works with the current code
  snapshot                   Builds a snapshot release.
  release                    Builds a release.
  release-manager-snapshot   Builds a snapshot release. The Go version defined in .go-version will be installed and used for the build.
  release-manager-release    Builds a snapshot release. The Go version defined in .go-version will be installed and used for the build.
  beats-dashboardse          Collects dashboards from all Beats and generates a zip file distribution.
Variables:
  BEATS                      Default values: auditbeat filebeat heartbeat journalbeat metricbeat packetbeat winlogbeat x-pack/functionbeat
  PYTHON_ENV                 Default values: $(BUILD_DIR)/python-env
  VIRTUALENV_PARAMS          Default values: 
  REVIEWDOG_OPTIONS          Default values: -diff "git diff master"

Copy link
Contributor

@cachedout cachedout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in one of the descriptions but otherwise looks 👍

Makefile Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Co-Authored-By: cachedout <[email protected]>
@v1v v1v added the needs_backport PR is waiting to be backported to other branches. label Apr 3, 2020
@v1v v1v merged commit d74bdeb into elastic:master Apr 6, 2020
@v1v v1v deleted the feature/help branch April 6, 2020 12:01
v1v added a commit to v1v/beats that referenced this pull request Apr 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation needs_backport PR is waiting to be backported to other branches.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants