openstack/reno
Code Issues Proposed changes

update docs for slug/uuid swap

Browse Source 
Change-Id: I009fc7a96b68b41f2b405ac225197f49c2093bb3
This commit is contained in:
Doug Hellmann
2015-10-02 12:57:42 +00:00
parent d1aaff7bc7
commit 12ff6ec46c
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/usage.rst
+4 -4
View File
@@ -7,13 +7,13 @@ Creating New Release Notes
The ``reno`` command line tool is used to create a new release note
file in the correct format and with a unique name. The ``create``
subcommand combines a random prefix with a "slug" value to make the
subcommand combines a random suffix with a "slug" value to make the
new file with a unique name that is easy to identify again later.
::
$ reno new slug-goes-here
Created new notes file in releasenotes/notes/95915aaedd3c48d8-slug-goes-here.yaml
Created new notes file in releasenotes/notes/slug-goes-here-95915aaedd3c48d8.yaml
Within OpenStack projects, ``reno`` is often run via tox instead of
being installed globally. For example
@@ -23,14 +23,14 @@ being installed globally. For example
$ tox -e venv -- reno new slug-goes-here
venv develop-inst-nodeps: /mnt/projects/release-notes-generation/reno
venv runtests: commands[0] | reno new slug-goes-here
Created new notes file in releasenotes/notes/95915aaedd3c48d8-slug-goes-here.yaml
Created new notes file in releasenotes/notes/slug-goes-here-95915aaedd3c48d8.yaml
venv: commands succeeded
congratulations :)
$ git status
Untracked files:
(use "git add <file>..." to include in what will be committed)
releasenotes/notes/13041418ce6be244-slug-goes-here.yaml
releasenotes/notes/95915aaedd3c48d8-slug-goes-here.yaml
By default the new note is created under ``./releasenotes/notes``. Use
the ``--rel-notes-dir`` to change the parent directory (the ``notes``