diff options
author | Michelle McDaniel <adiaaida@gmail.com> | 2016-08-30 13:41:27 -0700 |
---|---|---|
committer | Michelle McDaniel <adiaaida@gmail.com> | 2016-08-31 09:38:56 -0700 |
commit | 66f4808f974fdfc029efc16d41b6a4c442f9257f (patch) | |
tree | c7e5ce609222c9821110f84f1c077f11715d5b57 /Documentation | |
parent | 62f28d6d7801ce4c691194950798130502a4b13b (diff) | |
download | coreclr-66f4808f974fdfc029efc16d41b6a4c442f9257f.tar.gz coreclr-66f4808f974fdfc029efc16d41b6a4c442f9257f.tar.bz2 coreclr-66f4808f974fdfc029efc16d41b6a4c442f9257f.zip |
Update coding conventions
Add a note to the jit coding conventions that jit-format changes supersede
the conventions in the doc. Add a link to jit-format's documentation.
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/coding-guidelines/clr-jit-coding-conventions.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/coding-guidelines/clr-jit-coding-conventions.md b/Documentation/coding-guidelines/clr-jit-coding-conventions.md index 6b53b473b6..0bab27616a 100644 --- a/Documentation/coding-guidelines/clr-jit-coding-conventions.md +++ b/Documentation/coding-guidelines/clr-jit-coding-conventions.md @@ -16,6 +16,8 @@ Note that these conventions are different from the CLR C++ Coding Conventions, d > Note: the JIT currently doesn't follow some of these conventions very widely. The non-conformant code should be updated, eventually. +> Note: we now use jit-format to format our code. All changes it makes supersede the conventions in this doc. Please see the [jit-format documentation](https://github.com/dotnet/jitutils/blob/master/doc/getstarted.md#formatting-jit-source) for instructions on running jit-format. + # How to use this document * All new code written in the JIT should adhere to these conventions. |