diff options
author | Hans Wennborg <hans@hanshq.net> | 2018-09-07 14:18:34 +0000 |
---|---|---|
committer | Hans Wennborg <hans@hanshq.net> | 2018-09-07 14:18:34 +0000 |
commit | 0d7b2cb16c90b244a82e895a3c2aded6afcb6f1f (patch) | |
tree | 8848ebc99e848f3cdeba9fa0afdfee6437350589 | |
parent | f464f9b32267c8b792ceadb9b1b9509a8e5e8acf (diff) | |
download | llvm-0d7b2cb16c90b244a82e895a3c2aded6afcb6f1f.zip llvm-0d7b2cb16c90b244a82e895a3c2aded6afcb6f1f.tar.gz llvm-0d7b2cb16c90b244a82e895a3c2aded6afcb6f1f.tar.bz2 |
ReleaseNotes: tidy up for the release
llvm-svn: 341661
-rw-r--r-- | clang/docs/ReleaseNotes.rst | 183 |
1 files changed, 52 insertions, 131 deletions
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst index fc91228..e60611c 100644 --- a/clang/docs/ReleaseNotes.rst +++ b/clang/docs/ReleaseNotes.rst @@ -1,18 +1,12 @@ -======================================= -Clang 7.0.0 (In-Progress) Release Notes -======================================= +========================= +Clang 7.0.0 Release Notes +========================= .. contents:: :local: :depth: 2 -Written by the `LLVM Team <http://llvm.org/>`_ - -.. warning:: - - These are in-progress notes for the upcoming Clang 7 release. - Release notes for previous releases can be found on - `the Download Page <http://releases.llvm.org/download.html>`_. +Written by the `LLVM Team <https://llvm.org/>`_ Introduction ============ @@ -22,18 +16,13 @@ frontend, part of the LLVM Compiler Infrastructure, release 7.0.0. Here we describe the status of Clang in some detail, including major improvements from the previous release and new feature work. For the general LLVM release notes, see `the LLVM -documentation <http://llvm.org/docs/ReleaseNotes.html>`_. All LLVM +documentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM releases may be downloaded from the `LLVM releases web -site <http://llvm.org/releases/>`_. +site <https://llvm.org/releases/>`_. For more information about Clang or LLVM, including information about the -latest release, please see the `Clang Web Site <http://clang.llvm.org>`_ or the -`LLVM Web Site <http://llvm.org>`_. - -Note that if you are reading this file from a Subversion checkout or the -main Clang web page, this document applies to the *next* release, not -the current one. To see the release notes for a specific release, please -see the `releases page <http://llvm.org/releases/>`_. +latest release, please see the `Clang Web Site <https://clang.llvm.org>`_ or the +`LLVM Web Site <https://llvm.org>`_. What's New in Clang 7.0.0? ========================== @@ -55,9 +44,9 @@ Major New Features information, including the new .debug_names accelerator table. Type units and split DWARF are known not to conform, and higher optimization levels will likely get a mix of v4 and v5 formats. - + Improvements to Clang's diagnostics -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------- - ``-Wc++98-compat-extra-semi`` is a new flag, which was previously inseparable from ``-Wc++98-compat-pedantic``. The latter still controls the new flag. @@ -81,6 +70,9 @@ Non-comprehensive list of changes in this release For example, the ``clang`` binary will be called ``clang-7`` instead of ``clang-7.0``. +- The optimization flag to merge constants (``-fmerge-all-constants``) is no + longer applied by default. + - Clang implements a collection of recent fixes to the C++ standard's definition of "standard-layout". In particular, a class is only considered to be standard-layout if all base classes and the first data member (or bit-field) @@ -90,7 +82,7 @@ Non-comprehensive list of changes in this release to apply only to non-static data members and not to base classes. This fixes an ABI difference between Clang and GCC, but creates an ABI difference between Clang 7 and earlier versions. The old behavior can be restored by setting - ``-fclang-abi-compat`` to ``6`` or earlier. + ``-fclang-abi-compat`` to ``6`` or lower. - Clang implements the proposed resolution of LWG issue 2358, along with the `corresponding change to the Itanium C++ ABI @@ -114,64 +106,50 @@ Non-comprehensive list of changes in this release relocation scanning. The ``-faddrsig`` and ``-fno-addrsig`` flags can be used to control whether to emit the address-significance table. -- Integrated assembler is enabled by default on OpenBSD / FreeBSD +- The integrated assembler is enabled by default on OpenBSD / FreeBSD for MIPS 64-bit targets. -- On MIPS FreeBSD default CPUs have been changed to ``mips2`` +- On MIPS FreeBSD, default CPUs have been changed to ``mips2`` for 32-bit targets and ``mips3`` for 64-bit targets. -- ... New Compiler Flags ------------------ - ``-fstrict-float-cast-overflow`` and ``-fno-strict-float-cast-overflow``. - When a floating-point value is not representable in a destination integer - type, the code has undefined behavior according to the language standard. By + When converting a floating-point value to int and the value is not + representable in the destination integer type, + the code has undefined behavior according to the language standard. By default, Clang will not guarantee any particular result in that case. With the 'no-strict' option, Clang attempts to match the overflowing behavior of the target's native float-to-int conversion instructions. - ``-fforce-emit-vtables`` and ``-fno-force-emit-vtables``. - In order to improve devirtualization, forces emitting of vtables even in - modules where it isn't necessary. It causes more inline virtual functions - to be emitted. + In order to improve devirtualization, forces emission of vtables even in + modules where it isn't necessary. It causes more inline virtual functions + to be emitted. -- Added the``-mcrc`` and ``-mno-crc`` flags to enable/disable using +- Added the ``-mcrc`` and ``-mno-crc`` flags to enable/disable using of MIPS Cyclic Redundancy Check instructions. -- Added the``-mvirt`` and ``-mno-virt`` flags to enable/disable using +- Added the ``-mvirt`` and ``-mno-virt`` flags to enable/disable using of MIPS Virtualization instructions. -- Added the``-mginv`` and ``-mno-ginv`` flags to enable/disable using +- Added the ``-mginv`` and ``-mno-ginv`` flags to enable/disable using of MIPS Global INValidate instructions. -- ... - -Deprecated Compiler Flags -------------------------- - -The following options are deprecated and ignored. They will be removed in -future versions of Clang. - -- ... Modified Compiler Flags ----------------------- -- Before Clang 7, we prepended the `#` character to the `--autocomplete` - argument to enable cc1 flags. For example, when the `-cc1` or `-Xclang` flag +- Before Clang 7, we prepended the `#` character to the ``--autocomplete`` + argument to enable cc1 flags. For example, when the ``-cc1`` or ``-Xclang`` flag is in the :program:`clang` invocation, the shell executed - `clang --autocomplete=#-<flag to be completed>`. Clang 7 now requires the - whole invocation including all flags to be passed to the `--autocomplete` like - this: `clang --autocomplete=-cc1,-xc++,-fsyn`. - -New Pragmas in Clang --------------------- - -Clang now supports the ... + ``clang --autocomplete=#-<flag to be completed>``. Clang 7 now requires the + whole invocation including all flags to be passed to the ``--autocomplete`` like + this: ``clang --autocomplete=-cc1,-xc++,-fsyn``. Attribute Changes in Clang @@ -181,10 +159,8 @@ Attribute Changes in Clang based x86/x86-64 environments by using indirect functions. This implementation has a few minor limitations over the GCC implementation for the sake of AST sanity, however it is otherwise compatible with existing code using this - feature for GCC. Consult the documentation for the target attribute for more - information. - -- ... + feature for GCC. Consult the `documentation for the target attribute + <AttributeReference.html#target-gnu-target>`_ for more information. Windows Support --------------- @@ -196,8 +172,8 @@ Windows Support the pch file (matching cl.exe). This speeds up builds using pch files by around 30%. - - The /Ycfoo.h and /Yufoo.h flags can now be used without /FIfoo.h when - foo.h is instead included by an explicit `#include` directive. This means + - The ``/Ycfoo.h`` and ``/Yufoo.h`` flags can now be used without ``/FIfoo.h`` when + foo.h is instead included by an explicit ``#include`` directive. This means Visual Studio's default stdafx.h setup now uses precompiled headers with clang-cl. @@ -207,36 +183,12 @@ Windows Support explicit specify ``extern "C"``. (This was already the case for MSVC targets.) -- ... - - -C Language Changes in Clang ---------------------------- - -- ... - -... - -C11 Feature Support -^^^^^^^^^^^^^^^^^^^ - -... - -C++ Language Changes in Clang ------------------------------ - -- ... - -C++1z Feature Support -^^^^^^^^^^^^^^^^^^^^^ - -... Objective-C Language Changes in Clang ------------------------------------- Clang now supports the GNUstep Objective-C ABI v2 on ELF platforms. This is -enabled with the `-fobjc-runtime=gnustep-2.0` flag. The new ABI is incompatible +enabled with the ``-fobjc-runtime=gnustep-2.0`` flag. The new ABI is incompatible with the older GNUstep ABIs, which were incremental changes on the old GCC ABI. The new ABI provides richer reflection metadata and allows the linker to remove duplicate selector and protocol definitions, giving smaller binaries. Windows @@ -275,18 +227,19 @@ OpenMP Support in Clang ---------------------------------- - Clang gained basic support for OpenMP 4.5 offloading for NVPTX target. - To compile your program for NVPTX target use the following options: - `-fopenmp -fopenmp-targets=nvptx64-nvidia-cuda` for 64 bit platforms or - `-fopenmp -fopenmp-targets=nvptx-nvidia-cuda` for 32 bit platform. + + To compile your program for NVPTX target use the following options: + ``-fopenmp -fopenmp-targets=nvptx64-nvidia-cuda`` for 64 bit platforms or + ``-fopenmp -fopenmp-targets=nvptx-nvidia-cuda`` for 32 bit platform. - Passing options to the OpenMP device offloading toolchain can be done using - the `-Xopenmp-target=<triple> -opt=val` flag. In this way the `-opt=val` + the ``-Xopenmp-target=<triple> -opt=val`` flag. In this way the ``-opt=val`` option will be forwarded to the respective OpenMP device offloading toolchain described by the triple. For example passing the compute capability to the OpenMP NVPTX offloading toolchain can be done as follows: - `-Xopenmp-target=nvptx64-nvidia-cuda -march=sm_60`. For the case when only one - target offload toolchain is specified under the `-fopenmp-targets=<triples>` - option, then the triple can be skipped: `-Xopenmp-target -march=sm_60`. + ``-Xopenmp-target=nvptx64-nvidia-cuda -march=sm_60``. For the case when only one + target offload toolchain is specified under the ``-fopenmp-targets=<triples>`` + option, then the triple can be skipped: ``-Xopenmp-target -march=sm_60``. - Other bugfixes. @@ -295,10 +248,10 @@ CUDA Support in Clang - Clang will now try to locate the CUDA installation next to :program:`ptxas` in the `PATH` environment variable. This behavior can be turned off by passing - the new flag `--cuda-path-ignore-env`. + the new flag ``--cuda-path-ignore-env``. - Clang now supports generating object files with relocatable device code. This - feature needs to be enabled with `-fcuda-rdc` and my result in performance + feature needs to be enabled with ``-fcuda-rdc`` and may result in performance penalties compared to whole program compilation. Please note that NVIDIA's :program:`nvcc` must be used for linking. @@ -309,38 +262,22 @@ These are major API changes that have happened since the 6.0.0 release of Clang. If upgrading an external codebase that uses Clang as a library, this section should help get you past the largest hurdles of upgrading. -- The methods ``getLocStart``, ``getStartLoc`` and ``getLocEnd`` in the AST - classes are deprecated. New APIs ``getBeginLoc`` and ``getEndLoc`` should - be used instead. While the old methods remain in this release, they will +- The methods ``getLocStart``, ``getStartLoc`` and ``getLocEnd`` in the AST + classes are deprecated. New APIs ``getBeginLoc`` and ``getEndLoc`` should + be used instead. While the old methods remain in this release, they will not be present in the next release of Clang. -AST Matchers ------------- - -- ... - clang-format ------------ - Clang-format will now support detecting and formatting code snippets in raw - string literals. This is configured through the `RawStringFormats` style + string literals. This is configured through the ``RawStringFormats`` style option. -- ... - -libclang --------- - -... - - Static Analyzer --------------- -- The new `MmapWriteExec` checker had been introduced to detect attempts to map pages -both writable and executable. - -... +- The new `MmapWriteExec` checker had been introduced to detect attempts to map pages both writable and executable. .. _release-notes-ubsan: @@ -373,22 +310,6 @@ Undefined Behavior Sanitizer (UBSan) but the ``-fsanitize=implicit-integer-truncation`` check is enabled by ``-fsanitize=integer``. -Core Analysis Improvements -========================== - -- ... - -New Issues Found -================ - -- ... - -Python Binding Changes ----------------------- - -The following methods have been added: - -- ... libc++ Changes ============== @@ -404,7 +325,7 @@ Additional Information ====================== A wide variety of additional information is available on the `Clang web -page <http://clang.llvm.org/>`_. The web page contains versions of the +page <https://clang.llvm.org/>`_. The web page contains versions of the API documentation which are up-to-date with the Subversion version of the source code. You can access versions of these documents specific to this release by going into the "``clang/docs/``" directory in the Clang @@ -412,4 +333,4 @@ tree. If you have any questions or comments about Clang, please feel free to contact us via the `mailing -list <http://lists.llvm.org/mailman/listinfo/cfe-dev>`_. +list <https://lists.llvm.org/mailman/listinfo/cfe-dev>`_. |