Skip to content

Commit 3162593

Browse files
authored
Add 'make help' target (python#673)
1 parent dbcfa82 commit 3162593

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

Makefile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ LOGLINES=50
1414

1515
.PHONY: venv regen-requirements
1616

17+
## venv Create a venv with necessary tools
1718
venv: $(VENV_CHECK)
1819

20+
## clean Remove the venv
1921
clean:
2022
rm -rf venv
2123

@@ -24,6 +26,7 @@ $(VENV_CHECK): $(REQUIREMENTS)
2426
$(PIP) install -U pip
2527
$(PIP) install -r $(REQUIREMENTS)
2628

29+
## regen-requirements Regenerate pinned requirements file
2730
regen-requirements:
2831
$(SYSTEM_PYTHON) -m venv --clear venv
2932
$(PIP) install -U pip
@@ -34,13 +37,15 @@ regen-requirements:
3437

3538
.PHONY: check
3639

40+
## check Validate buildbot master configuration
3741
check: $(VENV_CHECK)
3842
$(BUILDBOT) checkconfig master
3943

4044
# Management targets
4145

4246
.PHONY: update-master start-master restart-master stop-master
4347

48+
## update-master Pull updates, upgrade, check config, and start master
4449
update-master: stop-master
4550
@if [ `git rev-parse --symbolic-full-name HEAD` = "refs/heads/main" ]; \
4651
then \
@@ -52,12 +57,15 @@ update-master: stop-master
5257
$(MAKE) check
5358
$(MAKE) start-master
5459

60+
## start-master Start the buildbot master
5561
start-master: TARGET=start
5662
start-master: run-target
5763

64+
## restart-master Restart the buildbot master
5865
restart-master: TARGET=restart
5966
restart-master: run-target
6067

68+
## stop-master Stop the buildbot master
6169
stop-master: TARGET=stop
6270
stop-master: run-target
6371
# issue #384: sometimes when "buildbot stop master" sends SIGINT to
@@ -73,9 +81,15 @@ stop-master: run-target
7381
run-target: $(VENV_CHECK)
7482
$(BUILDBOT) $(TARGET) master; tail -n$(LOGLINES) master/twistd.log
7583

84+
## git-update-requirements Create a branch with regenerated requirements
7685
git-update-requirements:
7786
git switch main
7887
git pull
7988
git switch -c reqs main
8089
make regen-requirements
8190
git ci -a -m "run make regen-requirements"
91+
92+
.PHONY: help
93+
help : Makefile
94+
@echo "Use \`make <target>' where <target> is one of"
95+
@sed -n 's/^##//p' $<

0 commit comments

Comments
 (0)