opendev
/
infra-manual
Code Issues Proposed changes

Merge "Reorder cookiecutter template section"

This commit is contained in:
Zuul 2018-04-09 14:19:40 +00:00 committed by Gerrit Code Review
parent d2cbbb46ea 8244b9e6fb
commit 5ab557d3e3
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

@ -800,22 +800,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.