node
node copied to clipboard
build: add more information to Makefile help
This PR adds more information to the Makefile by adding more help details to more targets:
make help
output
For more targets and info see the comments in the Makefile.
all Default target, builds node in out/Release/node.
bench-addons-build Build required addons for benchmark before running it.
binary Build release binary tarballs.
build-addons Build addons for Node.js.
build-ci Build everything for CI
build-js-native-api-tests Builds JS Native-API tests.
build-node-api-tests Builds Node-API tests.
cctest Runs the C++ tests using the built `cctest` executable.
clean Remove build artifacts.
clear-stalled Clear any stalled processes.
corepack-update Update Corepack to the latest version.
coverage-build-js Build JavaScript coverage files.
coverage-build Build coverage files.
coverage-clean Remove coverage artifacts.
coverage-report-js Report JavaScript coverage results
coverage-run-js Run JavaScript tests with coverage.
coverage-test Run the tests and generate a coverage report.
coverage Run the tests and generate a coverage report.
distclean Remove all build and test artifacts.
doc Builds Node.js, and then builds the documentation with the new binary.
docclean Remove the generated documentation.
docopen Open the documentation in a web browser.
docserve Serve the documentation on localhost:8000.
format-cpp-build Builds 'clang-format' tooling for C++ code formatting.
format-cpp-clean Removes 'clang-format' tooling for C++ code formatting.
format-cpp Format C++ diff from $CLANG_FORMAT_START to current changes
format-md Formats the markdown documents maintained by us in the codebase.
gen-openssl Generate platform dependent openssl files (requires docker)
help Print help for targets with comments.
install Installs node into $PREFIX (default=/usr/local).
jstest Runs addon tests and JS tests
lint-addon-docs Lints the addon documentation.
lint-clean Removes linting artifacts.
lint-cpp Lints the C++ code with cpplint.py and checkimports.py.
lint-js-fix Lints and fixes the JavaScript code with eslint.
lint-md Lints the markdown documents maintained by us in the codebase.
lint-py-build Builds resources needed to lint python files.
lint-py Lint the Python code with ruff.
lint-yaml-build Builds resources needed to lint YAML files.
lint-yaml Lints the YAML files with yamllint.
lint Run JS, C++, MD and doc linters.
list-gtests List all available C++ gtests.
pkg Builds the macOS installer for releases.
release-only Prepare Node.js for release.
run-ci Build and run all tests for CI
tar-headers Build the node header tarball.
tar Create a source tarball.
test-addons-clean Remove addon testing artifacts.
test-addons Run addon tests.
test-all-suites Run all test suites.
test-all-valgrind Test all valgrind tests
test-all Run default tests with both Debug and Release builds.
test-build-js-native-api Build JS Native-API tests.
test-build-node-api Build Node-API tests.
test-build Build all tests.
test-ci-js Build and test JavaScript with building anything else
test-ci-native Build and test addons without building anything else
test-ci Build and test everything (in CI)
test-cov Runs coverage tests
test-debug Run tests on a debug build.
test-doc-ci Builds, lints, and verifies the docs for CI.
test-doc Builds, lints, and verifies the docs.
test-hash-seed Verifies the hash seed used by V8 for hashing is random.
test-internet Run internet tests.
test-js-native-api-clean Remove JS Native-API testing artifacts.
test-js-native-api Run JS Native-API tests.
test-known-issues Run tests for known issues.
test-node-api-clean Remove Node-API testing artifacts.
test-node-api Run Node-API tests.
test-npm-publish Test the `npm publish` command.
test-npm Run the npm test suite on deps/npm.
test-only For a quick test, does not run linter or build docs.
test-tick-processor Run tick processor tests.
test-v8-all Run the entire V8 test suite, including intl, benchmarks, and updates.
test-v8-benchmarks Runs the v8 test suite, benchmarks.
test-v8-intl Runs the v8 test suite, intl tests.
test-v8-updates Runs the v8 test suite, updates.
test-v8 Runs the V8 test suite on deps/v8.
test-valgrind Runs valgrind tests
test-with-async-hooks Run tests with async hooks.
test-wpt-report Run the web platform tests and generate a report.
test-wpt Run the web platform tests.
test Runs default tests, linters, and builds docs.
testclean Remove test artifacts.
tooltest Tests the various tools.
uninstall Uninstalls node from $PREFIX (default=/usr/local).
v8 Builds deps/v8.