diff options
| -rw-r--r-- | BUILD.md | 9 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 3 |
2 files changed, 10 insertions, 2 deletions
@@ -197,6 +197,13 @@ specific requirements for configuring and building these components. - Please use `update_deps.py --help` to list additional options and read the internal documentation in `update_deps.py` for further information. +### Generated source code + +This repository contains generated source code in the `layers/generated` +directory which is not intended to be modified directly. Instead, changes should be +made to the corresponding generator in the `scripts` directory. The source files can +then be regenerated using `scripts/generate_source.py`. + ### Build Options When generating native platform build files through CMake, several options can @@ -696,7 +703,6 @@ Follow the setup steps for Linux or OSX above, then from your terminal: cd build-android ./update_external_sources_android.sh --no-build - ./android-generate.sh ndk-build -j4 #### Windows @@ -706,7 +712,6 @@ for VS2015: cd build-android update_external_sources_android.bat - android-generate.bat ndk-build ### Android Tests and Demos 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 |