diff options
| author | Mike Schuchardt <mikes@lunarg.com> | 2019-07-03 02:16:01 -0700 |
|---|---|---|
| committer | Mike Schuchardt <mikes@lunarg.com> | 2019-07-11 16:33:03 -0700 |
| commit | 27b35726d21d1e8a00aa58b7949bae69aeb6700d (patch) | |
| tree | 6032fc87d7639274518b32b6e9cd8dcdb7337884 /CONTRIBUTING.md | |
| parent | c249d53e5c6f1ef120864e455cd4998fb654a6d5 (diff) | |
| download | vulkan-validation-layers-27b35726d21d1e8a00aa58b7949bae69aeb6700d.tar.gz | |
docs: Add info about source code generation
Change-Id: Ib8909143f3bb9cfaa36c54f7523de0af0c18719b
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7597a78c..3a2990675 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -134,6 +134,9 @@ fix the problem, they should do so to better assist the user. * **Validation Statistics:** The `vk_validation_stats.py` script (in the scripts directory) inspects the layer and test source files and reports a variety of statistics on validation completeness and correctness. Before submitting a change you should run this script with the consistency check (`-c`) argument to ensure that your changes have not introduced any inconsistencies in the code. +* **Generated Source Code:** The `layers/generated` directory contains source code that is created by several +generator scripts in the `scripts` directory. All changes to these scripts must be submitted with the +corresponding generated output to keep the repository self-consistent. This requirement is enforced by both Travis CI and AppVeyor test configurations. Use `scripts/generate_source.py` to regenerate source files after modifying any of the generator scripts and before building and testing your changes. #### Coding Conventions for [CMake](http://cmake.org) files |