opendev
/
infra-manual
Code Issues Proposed changes

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
This commit is contained in:
Adam Spiers 2018-03-06 00:39:41 +00:00
parent 5ea4159531
commit 8244b9e6fb
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/creators.rst
View File

@ -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
<projectname> 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.