|author||Richard Smith <firstname.lastname@example.org>||2017-08-30 23:03:58 +0000|
|committer||Richard Smith <email@example.com>||2017-08-30 23:03:58 +0000|
Consistently use code font for command-line flags in the release notes.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/branches/release_50@312189 91177308-0d34-0410-b5e6-96231b3b80d8
1 files changed, 18 insertions, 19 deletions
diff --git a/docs/ReleaseNotes.rst b/docs/ReleaseNotes.rst
index 8341207815..c78b407365 100644
@@ -47,25 +47,25 @@ coroutine support. Here is `an example
Improvements to Clang's diagnostics
-- -Wcast-qual was implemented for C++. C-style casts are now properly
+- ``-Wcast-qual`` was implemented for C++. C-style casts are now properly
-- -Wunused-lambda-capture warns when a variable explicitly captured
+- ``-Wunused-lambda-capture`` warns when a variable explicitly captured
by a lambda is not used in the body of the lambda.
-- -Wstrict-prototypes is a new warning that warns about non-prototype
+- ``-Wstrict-prototypes`` is a new warning that warns about non-prototype
function and block declarations and types in C and Objective-C.
-- -Wunguarded-availability is a new warning that warns about uses of new
+- ``-Wunguarded-availability`` is a new warning that warns about uses of new
APIs that were introduced in a system whose version is newer than the
deployment target version. A new Objective-C expression ``@available`` has
been introduced to perform system version checking at runtime. This warning
is off by default to prevent unexpected warnings in existing projects.
- However, its less strict sibling -Wunguarded-availability-new is on by
+ However, its less strict sibling ``-Wunguarded-availability-new`` is on by
default. It warns about unguarded uses of APIs only when they were introduced
in or after macOS 10.13, iOS 11, tvOS 11 or watchOS 4.
-- The -Wdocumentation warning now allows the use of ``\param`` and
+- The ``-Wdocumentation`` warning now allows the use of ``\param`` and
``\returns`` documentation directives in the documentation comments for
declarations with a function or a block pointer type.
@@ -75,7 +75,8 @@ Improvements to Clang's diagnostics
New Compiler Flags
-- --autocomplete was implemented to obtain a list of flags and its arguments. This is used for shell autocompletion.
+- ``--autocomplete`` was implemented to obtain a list of flags and its arguments.
+ This is used for shell autocompletion.
Deprecated Compiler Flags
@@ -83,9 +84,9 @@ Deprecated Compiler Flags
The following options are deprecated and ignored. They will be removed in
future versions of Clang.
-- -fslp-vectorize-aggressive used to enable the BB vectorizing pass. They have been superseeded
+- ``-fslp-vectorize-aggressive`` used to enable the BB vectorizing pass. They have been superseeded
by the normal SLP vectorizer.
-- -fno-slp-vectorize-aggressive used to be the default behavior of clang.
+- ``-fno-slp-vectorize-aggressive`` used to be the default behavior of clang.
New Pragmas in Clang
@@ -134,11 +135,9 @@ a vector expression--occurs when:
- For compile time constant values, the above rule is weakened to consider the
- value of the scalar constant rather than the constant's type.
-- Floating point constants with precise integral representations are not
- implicitly converted to integer values, this is for compatibility with GCC.
+ value of the scalar constant rather than the constant's type. However,
+ for compatibility with GCC, floating point constants with precise integral
+ representations are not implicitly converted to integer values.
Currently the basic integer and floating point types with the following
operators are supported: ``+``, ``/``, ``-``, ``*``, ``%``, ``>``, ``<``,
@@ -313,7 +312,7 @@ Undefined Behavior Sanitizer (UBSan)
- The Undefined Behavior Sanitizer has a new check for pointer overflow. This
check is on by default. The flag to control this functionality is
Pointer overflow is an indicator of undefined behavior: when a pointer
indexing expression wraps around the address space, or produces other
@@ -321,10 +320,10 @@ Undefined Behavior Sanitizer (UBSan)
- UBSan has several new checks which detect violations of nullability
annotations. These checks are off by default. The flag to control this group
- of checks is -fsanitize=nullability. The checks can be individially enabled
- by -fsanitize=nullability-arg (which checks calls),
- -fsanitize=nullability-assign (which checks assignments), and
- -fsanitize=nullability-return (which checks return statements).
+ of checks is ``-fsanitize=nullability``. The checks can be individially enabled
+ by ``-fsanitize=nullability-arg`` (which checks calls),
+ ``-fsanitize=nullability-assign`` (which checks assignments), and
+ ``-fsanitize=nullability-return`` (which checks return statements).
- UBSan can now detect invalid loads from bitfields and from ObjC BOOLs.