From 019116361f9e0da2b34e9c5d8a222b6777a93e04 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= <alexis@freedom.press>
Date: Mon, 7 Apr 2025 15:49:46 +0200
Subject: [PATCH] Document the Makefile targets

It now outputs the following:

```
build-linux                  Build linux packages (.rpm and .deb)
build-macos-arm              Build macOS Apple Silicon package (.dmg)
build-macos-intel            Build macOS intel package (.dmg)
Dockerfile                   Regenerate the Dockerfile from its template
fix                          apply all the suggestions from ruff
help                         Print this message and exit.
lint                         Check the code for linting, formatting, and typing issues with ruff and mypy
regenerate-reference-pdfs    Regenerate the reference PDFs
test                         Run the tests
test-large                   Run large test set
```
---
 Makefile | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Makefile b/Makefile
index 38af94c..e4ae230 100644
--- a/Makefile
+++ b/Makefile
@@ -22,7 +22,7 @@ fix: ## apply all the suggestions from ruff
 	ruff format
 
 .PHONY: test
-test:
+test: ## Run the tests
 	# Make each GUI test run as a separate process, to avoid segfaults due to
 	# shared state.
 	# See more in https://github.com/freedomofpress/dangerzone/issues/493
@@ -47,11 +47,11 @@ test-large: test-large-init  ## Run large test set
 	python -m pytest --tb=no tests/test_large_set.py::TestLargeSet -v $(JUNIT_FLAGS) --junitxml=$(TEST_LARGE_RESULTS)
 	python $(TEST_LARGE_RESULTS)/report.py $(TEST_LARGE_RESULTS)
 
-Dockerfile: Dockerfile.env Dockerfile.in
+Dockerfile: Dockerfile.env Dockerfile.in ## Regenerate the Dockerfile from its template
 	poetry run jinja2 Dockerfile.in Dockerfile.env > Dockerfile
 
 .PHONY: poetry-install
-poetry-install:
+poetry-install: ## Install project dependencies
 	poetry install
 
 .PHONY: build-clean
@@ -59,19 +59,19 @@ build-clean:
 	poetry run doit clean
 
 .PHONY: build-macos-intel
-build-macos-intel: build-clean poetry-install
+build-macos-intel: build-clean poetry-install ## Build macOS intel package (.dmg)
 	poetry run doit -n 8
 
 .PHONY: build-macos-arm
-build-macos-arm: build-clean poetry-install
+build-macos-arm: build-clean poetry-install ## Build macOS Apple Silicon package (.dmg)
 	poetry run doit -n 8 macos_build_dmg
 
 .PHONY: build-linux
-build-linux: build-clean poetry-install
+build-linux: build-clean poetry-install ## Build linux packages (.rpm and .deb)
 	poetry run doit -n 8 fedora_rpm debian_deb
 
 .PHONY: regenerate-reference-pdfs
-regenerate-reference-pdfs:
+regenerate-reference-pdfs: ## Regenerate the reference PDFs
 	pytest tests/test_cli.py -k regenerate --generate-reference-pdfs
 # Makefile self-help borrowed from the securedrop-client project
 # Explaination of the below shell command should it ever break.