Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit edfb53f

Browse files
dianakhuangnsprenkle
authored andcommitted
feat: Rename dev.down to dev.remove-containers. (#1021)
This also adds some help text and updates documentation.
1 parent 54adeda commit edfb53f

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,10 +359,16 @@ dev.kill.%: ## Kill specific services.
359359
dev.rm-stopped: ## Remove stopped containers. Does not affect running containers.
360360
docker-compose rm --force
361361

362-
dev.down: ## Stop and remove containers and networks for all services.
362+
dev.down: ## Documentation for a change to naming
363+
@echo "dev.down has been renamed to dev.remove-containers. If this doesn't seem like what you were looking for, you probably want to be using dev.stop instead. See docs for more details."
364+
365+
dev.down.%:
366+
@echo "dev.down has been renamed to dev.remove-containers. If this doesn't seem like what you were looking for, you probably want to be using dev.stop instead. See docs for more details."
367+
368+
dev.remove-containers: ## Stop and remove containers and networks for all services.
363369
docker-compose down
364370

365-
dev.down.%: ## Stop and remove containers for specific services.
371+
dev.remove-containers.%: ## Stop and remove containers for specific services.
366372
docker-compose rm --force --stop $$(echo $* | tr + " ")
367373

368374

docs/devpi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ requirements of all Devstack applications.
1616
In general the operation of devpi should be transparent. You may notice
1717
some significant speedup in tox testing and ``paver update_prereqs``
1818
operations after the first run. Container storage should persist through
19-
``make dev.down`` and ``make dev.up.<service>`` operations.
19+
``make dev.remove-containers`` and ``make dev.up.<service>`` operations.
2020

2121
The devpi web interface can be browsed from the host at:
2222
http://localhost:3141/

docs/devstack_faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ manually install or upgrade Python packages in a container (via
4242
``pip install``, ``paver install_python_prereqs``, etc.), they will no
4343
longer be present if you restart the container. (Devstack Docker containers
4444
lose changes made to the filesystem when you reboot your computer, run
45-
``make down``, restart or upgrade Docker itself, etc.) If you want to ensure
45+
``make remove-containers``, restart or upgrade Docker itself, etc.) If you want to ensure
4646
that your new or upgraded packages are present in the container every time it
4747
starts, you have a few options:
4848

@@ -259,7 +259,7 @@ database migrations and package updates.
259259

260260
When switching to a branch which differs greatly from the one you've been
261261
working on (especially if the new branch is more recent), you may wish to
262-
halt and remove the existing containers via ``make down``, pull the latest Docker
262+
halt and remove the existing containers via ``make remove-containers``, pull the latest Docker
263263
images via ``make dev.pull.<service>``, and then re-run ``make dev.provision.<service>``
264264
in order to recreate up-to-date databases, static assets, etc.
265265

0 commit comments

Comments
 (0)