diff options
author | Nicolas Hennion <nicolashennion@gmail.com> | 2022-07-09 08:53:46 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-07-09 08:53:46 +0200 |
commit | d65030b036aaadc798747e538e1e51fc95a97637 (patch) | |
tree | 60e4782dd9b42d44885825edb57e0f226b5436c7 /Makefile | |
parent | 8a617c5276768dc1fa7bde8eb445ba4944813947 (diff) | |
parent | 7c9d09029c4b16da30d07a67294e5960a63e96dc (diff) |
Merge pull request #2078 from sylvainmouquet/feat-make-help
chore(Makefile): add command make help
Diffstat (limited to 'Makefile')
-rw-r--r-- | Makefile | 55 |
1 files changed, 31 insertions, 24 deletions
@@ -1,88 +1,95 @@ PORT?=8008 LASTTAG = $(shell git describe --tags --abbrev=0) -install: +# if the command is only `make`, the default tasks will be the printing of the help. +.DEFAULT_GOAL := help + +.PHONY: help +help: ## List all make commands available + @grep -E '^[\.a-zA-Z_%-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk -F ":" '{print $1}' | grep -v % | sed 's/\\//g' | sort | awk 'BEGIN {FS = ":[^:]*?##"}; {printf "\033[1;34mmake %-50s\033[0m %s\n", $$1, $$2}' + +install: ## sensible-browser "https://github.com/nicolargo/glances#installation" -venv-python: +venv-python: ## virtualenv -p /usr/bin/python3 venv -venv-dev: +venv-dev: ## ./venv/bin/pip install -r dev-requirements.txt ./venv/bin/pip install -r doc-requirements.txt -venv-dev-upgrade: +venv-dev-upgrade: ## ./venv/bin/pip install --upgrade pip ./venv/bin/pip install --upgrade -r dev-requirements.txt ./venv/bin/pip install --upgrade -r doc-requirements.txt -venv: +venv: ## ./venv/bin/pip install -r requirements.txt ./venv/bin/pip install -r optional-requirements.txt -venv-upgrade: +venv-upgrade: ## ./venv/bin/pip install --upgrade -r dev-requirements.txt ./venv/bin/pip install --upgrade -r requirements.txt ./venv/bin/pip install --upgrade -r optional-requirements.txt -test: venv +test: venv ## ./venv/bin/python ./unitest.py ./venv/bin/python ./unitest-restful.py ./venv/bin/python ./unitest-xmlrpc.py ./venv/bin/python -m black ./glances --check --exclude outputs/static -format: venv +format: venv ## ./venv/bin/python -m black ./glances --exclude outputs/static -docs: venv-dev +docs: venv-dev ## ./venv/bin/python -m glances -C ./conf/glances.conf --api-doc > ./docs/api.rst cd docs && ./build.sh && cd .. -docs-server: docs +docs-server: docs ## (sleep 2 && sensible-browser "http://localhost:$(PORT)") & cd docs/_build/html/ && ../../../venv/bin/python -m http.server $(PORT) -webui: venv-dev +webui: venv-dev ## cd glances/outputs/static/ && npm ci && npm run build -run: +run: ## ./venv/bin/python -m glances -C ./conf/glances.conf -run-debug: +run-debug: ## ./venv/bin/python -m glances -C ./conf/glances.conf -d -run-webserver: +run-webserver: ## ./venv/bin/python -m glances -C ./conf/glances.conf -w -run-restapiserver: +run-restapiserver: ## ./venv/bin/python -m glances -C ./conf/glances.conf -w --disable-webui -run-server: +run-server: ## ./venv/bin/python -m glances -C ./conf/glances.conf -s -run-client: +run-client: ## ./venv/bin/python -m glances -C ./conf/glances.conf -c localhost -run-browser: +run-browser: ## ./venv/bin/python -m glances -C ./conf/glances.conf --browser -show-version: +show-version: ## ./venv/bin/python -m glances -C ./conf/glances.conf -V -show-issue: +show-issue: ## ./venv/bin/python -m glances -C ./conf/glances.conf --issue -profiling: +profiling: ## @echo "Please complete and run: sudo ./venv/bin/py-spy record -o ./docs/_static/glances-flame.svg -d 60 -s --pid <GLANCES PID>" -trace-malloc: +trace-malloc: ## @echo "Malloc test is running, please wait ~30 secondes..." ./venv/bin/python -m glances -C ./conf/glances.conf --trace-malloc --stop-after 15 --quiet -memory-leak: +memory-leak: ## ./venv/bin/python -m glances -C ./conf/glances.conf --memory-leak -release-note: +release-note: ## git --no-pager log $(LASTTAG)..HEAD --first-parent --pretty=format:"* %s" @echo "\n" git --no-pager shortlog -s -n $(LASTTAG)..HEAD |