From 66f4808f974fdfc029efc16d41b6a4c442f9257f Mon Sep 17 00:00:00 2001 From: Michelle McDaniel Date: Tue, 30 Aug 2016 13:41:27 -0700 Subject: 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. --- Documentation/coding-guidelines/clr-jit-coding-conventions.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Documentation') 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. -- cgit v1.2.3