Add clang-tools-extra release notes
authorRichard Thomson <legalize@xmission.com>
Sun, 27 Mar 2016 05:06:57 +0000 (05:06 +0000)
committerRichard Thomson <legalize@xmission.com>
Sun, 27 Mar 2016 05:06:57 +0000 (05:06 +0000)
llvm-svn: 264531

clang-tools-extra/docs/ReleaseNotes.rst [new file with mode: 0644]
clang-tools-extra/docs/clang-tidy/checks/list.rst
clang-tools-extra/docs/index.rst

diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
new file mode 100644 (file)
index 0000000..d765fc1
--- /dev/null
@@ -0,0 +1,71 @@
+=================================================
+Extra Clang Tools 3.9 (In-Progress) Release Notes
+=================================================
+
+.. contents::
+   :local:
+   :depth: 2
+
+Written by the `LLVM Team <http://llvm.org/>`_
+
+.. warning::
+
+   These are in-progress notes for the upcoming Clang 3.9 release. You may
+   prefer the `Clang 3.8 Release Notes
+   <http://llvm.org/releases/3.8.0/tools/clang/docs/ReleaseNotes.html>`_.
+
+Introduction
+============
+
+This document contains the release notes for the Extra Clang Tools, part of the
+Clang release 3.9.  Here we describe the status of the Extra Clang Tools in some
+detail, including major improvements from the previous release and new feature
+work. For the general Clang release notes, see `the Clang documentation
+<http://llvm.org/releases/3.8.0/tools/clang/docs/ReleaseNotes.html>`_.  All LLVM
+releases may be downloaded from the `LLVM releases web
+site <http://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/>`_.
+
+What's New in Extra Clang Tools 3.9?
+====================================
+
+Some of the major new features and improvements to Extra Clang Tools are listed
+here. Generic improvements to Extra Clang Tools as a whole or to its underlying
+infrastructure are described first, followed by tool-specific sections.
+
+Major New Features
+------------------
+
+- Feature1...
+
+Improvements to ``clang-query``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The improvements are...
+
+Improvements to ``clang-rename``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The improvements are...
+
+Improvements to ``clang-tidy``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``clang-tidy``'s checks are constantly being improved to catch more issues,
+explain them more clearly, and provide more accurate fix-its for the issues
+identified.  The improvements since the 3.8 release include:
+
+-  ...
+
+Improvements to ``modularize``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The improvements are...
index 9b3e7d3..147d8b2 100644 (file)
@@ -88,6 +88,7 @@ Clang-Tidy Checks
    performance-faster-string-find
    performance-for-range-copy
    performance-implicit-cast-in-loop
+   performance-unnecessary-copy-initialization
    readability-braces-around-statements
    readability-container-size-empty
    readability-else-after-return
index f0b7b95..d9035fc 100644 (file)
@@ -10,6 +10,10 @@ Introduction
 Welcome to the clang-tools-extra project which contains extra tools built using
 Clang's tooling API's.
 
+.. toctree::
+   :maxdepth: 1
+
+   ReleaseNotes
 
 Contents
 ========