From 8244b9e6fb78618ec9b9f6b6a713c82544ead0aa Mon Sep 17 00:00:00 2001 From: Adam Spiers Date: Tue, 6 Mar 2018 00:39:41 +0000 Subject: [PATCH] Reorder cookiecutter template section cookiecutter's -f option enables destructive behaviour, so turn the note into a warning. Also move the command demonstrating use of the main cookiecutter template to be closer to the sentence referencing it, so that only the warning is in between them. Change-Id: I2894a778c43ed98223dff250a08718def9797685 --- doc/source/creators.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/source/creators.rst b/doc/source/creators.rst index eb07971..2bcb358 100644 --- a/doc/source/creators.rst +++ b/doc/source/creators.rst @@ -780,22 +780,22 @@ Choosing the Right cookiecutter Template ---------------------------------------- The template in ``openstack-dev/cookiecutter`` is suitable for -most projects. +most projects. It can be used as follows: -.. note:: +.. warning:: Cookiecutter with '-f' option overwrites the contents of the directory. Be careful when working with non-empty projects, it will overwrite any files you have which match names in the cookiecutter repository. -Remember, as mentioned earlier, these commands should typically be used only -if you are working with an empty repository. - :: $ cookiecutter -f https://git.openstack.org/openstack-dev/cookiecutter +Remember, as mentioned earlier, these commands should typically be used only +if you are working with an empty repository. + The template in ``openstack-dev/oslo-cookiecutter`` should be used for Oslo libraries.