From 89551b2b6205e03a1d75224b90bfe60e290d412a Mon Sep 17 00:00:00 2001 From: jinder1s Date: Thu, 4 Mar 2021 14:51:57 -0500 Subject: [PATCH 1/4] doc: moving the recommended variant of down command to top --- docs/devstack_interface.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/devstack_interface.rst b/docs/devstack_interface.rst index 07e2ce3ecf..d3c1822208 100644 --- a/docs/devstack_interface.rst +++ b/docs/devstack_interface.rst @@ -67,15 +67,16 @@ Useful Commands and Summary When to use: When you are pausing your work on this container/devstack and you want to pick back up from where you left off. Next time you use dev.up to bring up containers, you should be able to mostly pick back up from where you started. -- ``dev.down.``: stops the specified container and also removes the stopped containers as well as any networks that were created. Next time you use dev.up to bring up container, your container have reverted back to the pulled image. +- ``dev.down``: stops and removes all running containers as well as any networks that were created. Next time you use dev.up to bring up container, your containers have reverted back to the pulled image. Note: This will not affect content of the databases. - Note: This will only bring down 's container and not its dependencies. + When to use: use this command only if you are okay with removing any changes you might have made to your containers - When to use: use this command only if you are okay with removing any changes you might have made to the container + Variation: + + ``make dev.down.`` will stop and remove only the specified container. - Variation: ``make dev.down`` will stop all your containers + Note: This will only bring down 's container and not its dependencies. - ``dev.shell.``: used to enter the shell of the specified service container. From f7f9ae83af14e30f632e0c3ece8e82c710e6ad09 Mon Sep 17 00:00:00 2001 From: jinder1s Date: Thu, 4 Mar 2021 14:53:12 -0500 Subject: [PATCH 2/4] squash: formatting --- docs/devstack_interface.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/devstack_interface.rst b/docs/devstack_interface.rst index d3c1822208..bb58ff404b 100644 --- a/docs/devstack_interface.rst +++ b/docs/devstack_interface.rst @@ -74,6 +74,7 @@ Useful Commands and Summary When to use: use this command only if you are okay with removing any changes you might have made to your containers Variation: + + ``make dev.down.`` will stop and remove only the specified container. Note: This will only bring down 's container and not its dependencies. From 7802925d04445bec53d060a928dc8c59c8a7e52a Mon Sep 17 00:00:00 2001 From: jinder1s Date: Thu, 4 Mar 2021 14:54:32 -0500 Subject: [PATCH 3/4] squash: grammer --- docs/devstack_interface.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/devstack_interface.rst b/docs/devstack_interface.rst index bb58ff404b..a527075e1a 100644 --- a/docs/devstack_interface.rst +++ b/docs/devstack_interface.rst @@ -67,7 +67,7 @@ Useful Commands and Summary When to use: When you are pausing your work on this container/devstack and you want to pick back up from where you left off. Next time you use dev.up to bring up containers, you should be able to mostly pick back up from where you started. -- ``dev.down``: stops and removes all running containers as well as any networks that were created. Next time you use dev.up to bring up container, your containers have reverted back to the pulled image. +- ``dev.down``: stops and removes all running containers as well as any networks that were created. Next time you use dev.up. to bring up containers, your containers have reverted back to the pulled image. Note: This will not affect content of the databases. From a977a74a68a44ac8676ff42bd58cdca120792d50 Mon Sep 17 00:00:00 2001 From: jinder1s Date: Fri, 5 Mar 2021 09:55:22 -0500 Subject: [PATCH 4/4] squash: also improving stop docs --- docs/devstack_interface.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/devstack_interface.rst b/docs/devstack_interface.rst index a527075e1a..afe8801af4 100644 --- a/docs/devstack_interface.rst +++ b/docs/devstack_interface.rst @@ -63,15 +63,18 @@ Useful Commands and Summary + ``make dev.up.without-deps.`` will only bring up the container -- ``dev.stop.``: only stops the container. This does not remove the container or the networks it has created +- ``dev.stop``: Stops all running containers. This does not remove the containers or the networks they had created - When to use: When you are pausing your work on this container/devstack and you want to pick back up from where you left off. Next time you use dev.up to bring up containers, you should be able to mostly pick back up from where you started. + When to use: When you are pausing your work on devstack and you want to pick back up from where you left off. Next time you use dev.up. to bring up containers, you should be able to mostly pick back up from where you started. + + Variation: + + ``make dev.stop.`` will only stop the specified container - ``dev.down``: stops and removes all running containers as well as any networks that were created. Next time you use dev.up. to bring up containers, your containers have reverted back to the pulled image. Note: This will not affect content of the databases. - When to use: use this command only if you are okay with removing any changes you might have made to your containers + When to use: use this command only if you are okay with removing any changes you might have made to your containers. You will likely want to use ``make dev.stop`` instead of ``make dev.down``. Variation: