Lines Matching +full:formatting +full:- +full:error +full:- +full:messages
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.
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)…
56 #### **Coding Conventions and Formatting**
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…
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…
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 .
79 * **Commit Messages**
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, …
90 That said, please ensure that the repository compiles and passes tests without error for each commi…
92 -- the automatic Github Travis and AppVeyor continuous integration features will assist in enforcin…
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.
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…
121 …ould cause your new validation check to identify the violation and issue a validation error report.
122 And finally, the test should check that the validation error report is generated and consider the t…
130 validation objects (thread_safety, object lifetimes) are more special-purpose and are mostly code-g…
131 * **Validation Error/Warning Messages:** Strive to give specific information describing the partic…
132 output all of the applicable Vulkan Objects and related values. Also, ensure that when messages can…
136 script with the consistency check (`-c`) argument to ensure that your changes have not introduced a…
139 corresponding generated output to keep the repository self-consistent. This requirement is enforced…
142 …BUILD.md](https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/BUILD.md#generated-s…
149 * CMake functions are lower-case.
150 * Variable and keyword names are upper-case.
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.
157 * Disable any formatting of a block of lines by surrounding that block with
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
163 that can corrupt the formatting of comment lines in CMake files.
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,