openstack/nova
Code Issues Proposed changes

add hints to api_samples documentation

Browse Source 
Based on my own experience and questions I recently answered in
the openstack-nova channel, these hints could help developers.

Change-Id: Id7350f1a6a834b0de8456fdc28c2db890f2971de
This commit is contained in:
Melanie Witt 2013-10-21 23:39:49 +00:00
parent f119908b26
commit 3e6004d4ea
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
nova/tests/integrated/api_samples/README.rst
View File

@ -19,3 +19,11 @@ If new tests are added or the .tpl files are changed due to bug fixes, the
samples must be regenerated so they are in sync with the templates, as
there is an additional test which reloads the documentation and
ensures that it's in sync.
Debugging sample generation
---------------------------
If a .tpl is changed, its matching .xml and .json must be removed
else the samples won't be generated. If an entirely new extension is
added, a directory for it must be created before its samples will
be generated.