about summary refs log tree commit diff
path: root/src/doc/rustc
diff options
context:
space:
mode:
authorAndrew Paverd <andrew.paverd@microsoft.com>2020-07-14 15:27:42 +0100
committerAndrew Paverd <andrew.paverd@microsoft.com>2020-07-14 15:27:42 +0100
commit31c7aae1136b4d80f0256e269ca8086fd3fbdddd (patch)
tree1cad41bdc1b23ac926a9ee9621e562dac3ea39f8 /src/doc/rustc
parentc724b67e1b474262917a5154d74e7072267593fe (diff)
downloadrust-31c7aae1136b4d80f0256e269ca8086fd3fbdddd.tar.gz
rust-31c7aae1136b4d80f0256e269ca8086fd3fbdddd.zip
Stabilize control-flow-guard codegen option
Diffstat (limited to 'src/doc/rustc')
-rw-r--r--src/doc/rustc/src/codegen-options/index.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/doc/rustc/src/codegen-options/index.md b/src/doc/rustc/src/codegen-options/index.md
index 0b4bb05c1db..35904e15d3f 100644
--- a/src/doc/rustc/src/codegen-options/index.md
+++ b/src/doc/rustc/src/codegen-options/index.md
@@ -42,6 +42,18 @@ generated code, but may be slower to compile.
 The default value, if not specified, is 16 for non-incremental builds. For
 incremental builds the default is 256 which allows caching to be more granular.
 
+## control-flow-guard
+
+This flag controls whether LLVM enables the Windows [Control Flow 
+Guard](https://docs.microsoft.com/en-us/windows/win32/secbp/control-flow-guard) 
+platform security feature. This flag is currently ignored for non-Windows targets. 
+It takes one of the following values:
+
+* `y`, `yes`, `on`, `checks`, or no value: enable Control Flow Guard.
+* `nochecks`: emit Control Flow Guard metadata without runtime enforcement checks (this 
+should only be used for testing purposes as it does not provide security enforcement).
+* `n`, `no`, `off`: do not enable Control Flow Guard (the default).
+
 ## debug-assertions
 
 This flag lets you turn `cfg(debug_assertions)` [conditional