Lines Matching +full:code +full:- +full:format +full:- +full:check
5 The source code for The Vulkan-ValidationLayer components is sponsored by Khronos and LunarG.
6 * [Khronos Vulkan-ValidationLayers](https://github.com/KhronosGroup/Vulkan-ValidationLayers)
17 * Examine the [issues list](https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues)
19 * Alternatively, run the `vk_validation_stats.py` script (in the scripts directory) with the `-todo`
20 command line argument to see a list of as-yet unimplemented validation checks.
21 * Having selected a validation check to work on, it is often efficient to implement a block of rela…
23 or csv format) to identify related checks that may be implemented simultaneously.
28 Please see the [section about Validation Layers](#special-considerations-for-validation-layers)
47 This will involve [forking the repository](https://help.github.com/articles/fork-a-repo/),
48 …mmits, and then [submitting a pull request](https://help.github.com/articles/using-pull-requests/).
49 * Please read and adhere to the style and process [guidelines ](#coding-conventions-and-formatting)…
57 …le guide](https://google.github.io/styleguide/cppguide.html)** for source code with the following …
58 …* The column limit is 132 (as opposed to the default value 80). The clang-format tool will handle …
59 …* The indent is 4 spaces instead of the default 2 spaces. Again, the clang-format tool will handle…
61 decision during code review. This should be used responsibly. An example of a bad reason is "I don'…
64 * Run **clang-format** on your changes to maintain consistent formatting
65 * There are `.clang-format` files present in the repository to define clang-format settings
66 which are found and used automatically by clang-format.
67 …* **clang-format** binaries are available from the LLVM orginization, here: [LLVM](https://clang.l…
68 …currently uses clang-format version 5.0.0 to check that the lines of code you have changed are for…
69 recommended that you use the same version to format your code prior to submission.
73 > $ git add -u .
74 > $ git clang-format --style=file
75 > # Check to see if clang-format made any changes and if they are OK.
76 > $ git add -u .
80 …* Limit the subject line to 64 characters -- this allows the information to display correctly in g…
81 …* Begin subject line with a one-word component description followed by a colon (e.g. build, docs, …
92 -- the automatic Github Travis and AppVeyor continuous integration features will assist in enforcin…
95 * Run the existing tests in the repository before and after each of your commits to check for any r…
105 * On Windows, a quick sanity check can be run from inside Visual Studio -- just run the `vk_layer_v…
108 * Note that some tests may fail with known issues or driver-specific problems.
111 * Feel free to subject your code changes to other tests as well!
114 …-ci.org/KhronosGroup/Vulkan-ValidationLayers) with the sequence of commands driven by the [.travis…
116 …-ValidationLayers/tree/master/tests/device_profiles) profiles using the [devsim layer](https://git…
119 * **Validation Tests:** If you are submitting a change that adds a new validation check, you shoul…
120 The negative test function purposely violates the validation rule that the new validation check is …
121 The test should cause your new validation check to identify the violation and issue a validation er…
122 And finally, the test should check that the validation error report is generated and consider the t…
125 at the same time as the new validation check itself. There are many existing validation tests in th…
130 validation objects (thread_safety, object lifetimes) are more special-purpose and are mostly code-g…
136 …ript with the consistency check (`-c`) argument to ensure that your changes have not introduced an…
137 * **Generated Source Code:** The `layers/generated` directory contains source code that is created …
139 corresponding generated output to keep the repository self-consistent. This requirement is enforced…
142 …ILD.md](https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/BUILD.md#generated-sou…
146 * When editing configuration files for CMake, follow the style conventions of the surrounding code.
149 * CMake functions are lower-case.
150 * Variable and keyword names are upper-case.
151 * The format is defined by
152 [cmake-format](https://github.com/cheshirekow/cmake_format)
153 using the `.cmake-format.py` file in the repository to define the settings.
154 See the cmake-format page for information about its simple markup for comments.
158 `# cmake-format: off` and `# cmake-format: on` comment lines.
160 * To run: `cmake-format --in-place $FILENAME`
161 * **IMPORTANT (June 2018)** cmake-format v0.3.6 has a
164 A workaround is to use the following command _before_ running cmake-format:
165 `sed --in-place='' 's/^ *#/#/' $FILENAME`
169 You will be prompted with a one-time "click-through" CLA dialog as part of submitting your pull req…
174 All contributions made to the Vulkan-ValidationLayers repository are Khronos branded and as such,