Skip to content

Commit

Permalink
refactor: moves docker targets help information into docker.mk and al…
Browse files Browse the repository at this point in the history
…so reformats the Makefile help. (#213)
  • Loading branch information
Artanias authored Feb 6, 2025
1 parent 1eb19c2 commit fcd1d24
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 21 deletions.
15 changes: 3 additions & 12 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,9 @@ reinstall: uninstall install
todo-list: clean-all
@grep --color=auto -r -n 'TODO' ./* --exclude=Makefile --exclude-dir=docs

help: help-general help-translate
help: general-help docker-help translate-help

help-general:
general-help:
@echo "Usage:"
@echo " make [targets] [arguments]"
@echo
Expand All @@ -195,16 +195,7 @@ help-general:
@echo " clean-cache Delete __pycache__ folders created by pytest framework;"
@echo " clean Remove generated while installing and testing files in the source directory (contains clean-cache);"
@echo " clean-all Remove all generated files such as created docker files, debian and sources (contains clean);"
@echo " help Display this message and exit."
@echo
@echo "Docker:"
@echo " docker-run Runs docker container with installed util;"
@echo " docker-image Build docker image;"
@echo " ALL=[1|0] REBUILD=[1|0]"
@echo " docker-test Runs unit tests with pytest framework in the docker container;"
@echo " docker-autotest Runs autotests in docker container;"
@echo " docker-build-package Build the debian package in special docker image;"
@echo " docker-rmi ALL=[1|0] Delete created docker images."
@echo " help Displays information about all available targets."
@echo


Expand Down
12 changes: 12 additions & 0 deletions docker/docker.mk
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
docker-help:
@echo "Docker:"
@echo " docker-run Runs docker container with installed util;"
@echo " docker-image Build docker image;"
@echo " ALL=[1|0] REBUILD=[1|0]"
@echo " docker-test Runs unit tests with pytest framework in the docker container;"
@echo " docker-autotest Runs autotests in docker container;"
@echo " docker-build-package Build the debian package in special docker image;"
@echo " docker-rmi ALL=[1|0] Delete created docker images;"
@echo " docker-help Displays information about available docker targets."
@echo

docker-base-image: substitute-sources substitute-docker
@docker image inspect $(BASE_DOCKER_TAG) > /dev/null 2>&1 || ( \
echo "Building base docker image." && \
Expand Down
19 changes: 10 additions & 9 deletions locales/i18n.mk
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
LOCALES_DIR := locales/


translate-help:
@echo "Translate:"
@echo " translate-extract Extracts all lines that need to be translated;"
@echo " translate-update Updates all po files with new code changes;"
@echo " translate-compile Compile message catalogs to MO files;"
@echo " translate-init Initializing a new language for translation;"
@echo " LANGUAGE=..."
@echo " translate-help Displays information about available translation targets."
@echo

translate-extract:
pybabel extract --mapping-file ${LOCALES_DIR}/babel.cfg \
--keywords _ \
Expand Down Expand Up @@ -32,12 +42,3 @@ translate-init:
echo "You should provide the 'LANGUAGE' variable for initializing translation."; \
exit 1; \
fi

help-translate:
@echo "Translate:"
@echo " translate-extract Extracts all lines that need to be translated;"
@echo " translate-update Updates all po files with new code changes;"
@echo " translate-compile Compile message catalogs to MO files;"
@echo " translate-init Initializing a new language for translation."
@echo " LANGUAGE=..."
@echo

0 comments on commit fcd1d24

Please sign in to comment.