openstack/diskimage-builder
Code Issues Proposed changes

Document only exectuables in phase dirs policy

Browse Source 
Having data files in the phase subdirs is an easy source of confusion
in reviews (especially when the data file is a script) and theres really
no reason to be putting data files there at this point. Lets make a
convention out of not doing this.

Change-Id: I99571a2a49e14e8c709af20f6d13d662ac745eb4
This commit is contained in:
Gregory Haynes 2015-06-16 17:03:17 +00:00
parent c9f44b29bb
commit 9a166b9df6
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/developer/developing_elements.rst
View File

@ -33,7 +33,10 @@ Phase Subdirectories
Make as many of the following subdirectories as you need, depending on what Make as many of the following subdirectories as you need, depending on what
part of the process you need to customise. The subdirectories are executed in part of the process you need to customise. The subdirectories are executed in
the order given here. Scripts within the subdirectories should be named with a the order given here. Scripts within the subdirectories should be named with a
two-digit numeric prefix, and are executed in numeric order. two-digit numeric prefix, and are executed in numeric order. Only files which
are marked executable (+x) will be run, so other files can be stored in these
directories if needed. As a convention, we try to only store executable scripts
in the phase subdirectories and store data files elsewhere in the element.
* root.d: Create or adapt the initial root filesystem content. This is where * root.d: Create or adapt the initial root filesystem content. This is where
alternative distribution support is added, or customisations such as alternative distribution support is added, or customisations such as