diff options
| author | Sean Silva <silvas@purdue.edu> | 2012-12-23 01:19:35 +0000 |
|---|---|---|
| committer | Sean Silva <silvas@purdue.edu> | 2012-12-23 01:19:35 +0000 |
| commit | fe25144e6819d8ac47658afce4789c6029d7ad5c (patch) | |
| tree | 3e813f460b8ec42892c64cd87947a2c2deb136d3 /clang | |
| parent | 6f372e6533ccc054b96a2e5e68d92c1da532dcbe (diff) | |
| download | bcm5719-llvm-fe25144e6819d8ac47658afce4789c6029d7ad5c.tar.gz bcm5719-llvm-fe25144e6819d8ac47658afce4789c6029d7ad5c.zip | |
docs: Convert ReleaseNotes to reST.
This is the last of the "regular" documents to convert to reST, and so
I'm declaring the initial clang reST conversion "done".
However,
- There are some documents in clang/www/ which probably should
be migrated into clang/docs/, such as www/OpenProjects.html
The primary thing blocking me from doing this right now is not knowing
how to set up a redirect so that the old URL's continue to work.
- LibASTMatchersReference.html is not reST. This page is auto-generated
by clang/docs/tools/dump_ast_matchers.py from the source and has some
collapse/expand logic that isn't expressible directly with Sphinx, so
just converting it to reST is not really a good strategy.
Manuel Klimek and I discussed this and the general agreed-upon
direction is making that page data-driven so that it, say, pulls in an
auto-generated blob of JSON which describes the matchers and builds up
the "matcher reference" part of the page with a small amount of JS.
- There are some rogue .txt files hanging around.
Also, I dropped the little dragon logo at the top because Sphinx was
warning about an external image reference (not sure why, but meh, I
didn't want to fight it). If anything, we would want such a logo
integrated into the site's overall theme, rather than hardcoded here.
llvm-svn: 170994
Diffstat (limited to 'clang')
| -rw-r--r-- | clang/docs/ReleaseNotes.html | 181 | ||||
| -rw-r--r-- | clang/docs/ReleaseNotes.rst | 119 | ||||
| -rw-r--r-- | clang/docs/index.rst | 1 |
3 files changed, 120 insertions, 181 deletions
diff --git a/clang/docs/ReleaseNotes.html b/clang/docs/ReleaseNotes.html deleted file mode 100644 index 93a5237ff78..00000000000 --- a/clang/docs/ReleaseNotes.html +++ /dev/null @@ -1,181 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" - "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<title>Clang 3.3 Release Notes</title> -<link type="text/css" rel="stylesheet" href="../menu.css"> -<link type="text/css" rel="stylesheet" href="../content.css"> -<style type="text/css"> -td { - vertical-align: top; -} -</style> -</head> -<body> - -<!--#include virtual="../menu.html.incl"--> - -<div id="content"> - -<h1>Clang 3.3 Release Notes</h1> - -<img style="float:right" src="http://llvm.org/img/DragonSmall.png" - width="136" height="136" alt="LLVM Dragon Logo"> - -<ul> - <li><a href="#intro">Introduction</a></li> - <li><a href="#whatsnew">What's New in Clang 3.3?</a> - <ul> - <li><a href="#majorfeatures">Major New Features</a></li> - <li><a href="#newflags">New Compiler Flags</a></li> - <li><a href="#cchanges">C Language Changes</a></li> - <li><a href="#cxxchanges">C++ Language Changes</a></li> - <li><a href="#objcchanges">Objective-C Language Changes</a></li> - <li><a href="#apichanges">Internal API Changes</a></li> - <li><a href="#pythonchanges">Python Binding Changes</a></li> - </ul> - </li> - <li><a href="#knownproblems">Known Problems</a></li> - <li><a href="#additionalinfo">Additional Information</a></li> -</ul> - -<div class="doc_author"> - <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p> -</div> - -<h1 style="color:red">These are in-progress notes for the upcoming Clang 3.3 -release.<br> -You may prefer the -<a href="http://llvm.org/releases/3.2/docs/ClangReleaseNotes.html">Clang 3.2 -Release Notes</a>.</h1> - -<!-- ======================================================================= --> -<h2 id="intro">Introduction</h2> -<!-- ======================================================================= --> - -<p>This document contains the release notes for the Clang C/C++/Objective-C - frontend, part of the LLVM Compiler Infrastructure, release 3.3. 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 <a href="http://llvm.org/docs/ReleaseNotes.html">the LLVM - documentation</a>. All LLVM releases may be downloaded from the - <a href="http://llvm.org/releases/">LLVM releases web site</a>.</p> - -<p>For more information about Clang or LLVM, including information about the - latest release, please check out the main please see the - <a href="http://clang.llvm.org">Clang Web Site</a> or the - <a href="http://llvm.org">LLVM Web Site</a>. - -<p>Note that if you are reading this file from a Subversion checkout or the main - Clang web page, this document applies to the <i>next</i> release, not the - current one. To see the release notes for a specific release, please see the - <a href="http://llvm.org/releases/">releases page</a>.</p> - -<!-- ======================================================================= --> -<h2 id="whatsnew">What's New in Clang 3.3?</h2> -<!-- ======================================================================= --> - -<p>Some of the major new features and improvements to Clang are listed here. - Generic improvements to Clang as a whole or to its underlying infrastructure - are described first, followed by language-specific sections with improvements - to Clang's support for those languages.</p> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="majorfeatures">Major New Features</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> - -<h4 id="diagnostics">Improvements to Clang's diagnostics</h4> - -<p>Clang's diagnostics are constantly being improved to catch more issues, -explain them more clearly, and provide more accurate source information about -them. The improvements since the 3.2 release include:</p> - -<ul> - <li>...</li> -</ul> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="newflags">New Compiler Flags</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<ul> - <li>...</li> -</ul> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="cchanges">C Language Changes in Clang</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> - -<h4 id="c11changes">C11 Feature Support</h4> - -<p>...</p> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="cxxchanges">C++ Language Changes in Clang</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> - -<h4 id="cxx11changes">C++11 Feature Support</h4> - -<p>...</p> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="objcchanges">Objective-C Language Changes in Clang</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> - -<p>...</p> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="apichanges">Internal API Changes</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> - -<p>These are major API changes that have happened since the 3.2 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.</p> - -<h4 id="api1">API change 1</h4> - -<p>...</p> - -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> -<h3 id="pythonchanges">Python Binding Changes</h3> -<!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> - -The following methods have been added: -<ul> - <li>...</li> -</ul> - -<!-- ======================================================================= --> -<h2 id="knownproblems">Significant Known Problems</h2> -<!-- ======================================================================= --> - -<!-- ======================================================================= --> -<h2 id="additionalinfo">Additional Information</h2> -<!-- ======================================================================= --> - -<p>A wide variety of additional information is available on the - <a href="http://clang.llvm.org/">Clang web page</a>. 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 "<tt>clang/doc/</tt>" directory in - the Clang tree.</p> - -<p>If you have any questions or comments about Clang, please feel free to - contact us via - the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev"> mailing - list</a>.</p> - -<!-- ======================================================================= --> -<!-- Likely 3.2 release notes --> -<!-- ======================================================================= --> -<!-- -This is just a section to hold things that have already gotten started and -should likely pick up proper release notes in 3.2. - -- C1X and C++11 atomics infrastructure and support -- CUDA support? - ---> - -</div> -</body> -</html> diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst new file mode 100644 index 00000000000..27e42bc82ff --- /dev/null +++ b/clang/docs/ReleaseNotes.rst @@ -0,0 +1,119 @@ +======================= +Clang 3.3 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.3 release. You may + prefer the `Clang 3.2 Release Notes + <http://llvm.org/releases/3.2/docs/ClangReleaseNotes.html>`_. + +Introduction +============ + +This document contains the release notes for the Clang C/C++/Objective-C +frontend, part of the LLVM Compiler Infrastructure, release 3.3. 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 +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 check out the main 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 Clang 3.3? +======================== + +Some of the major new features and improvements to Clang are listed +here. Generic improvements to Clang as a whole or to its underlying +infrastructure are described first, followed by language-specific +sections with improvements to Clang's support for those languages. + +Major New Features +------------------ + +Improvements to Clang's diagnostics +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Clang's diagnostics are constantly being improved to catch more issues, +explain them more clearly, and provide more accurate source information +about them. The improvements since the 3.2 release include: + +- ... + +New Compiler Flags +------------------ + +- ... + +C Language Changes in Clang +--------------------------- + +C11 Feature Support +^^^^^^^^^^^^^^^^^^^ + +... + +C++ Language Changes in Clang +----------------------------- + +C++11 Feature Support +^^^^^^^^^^^^^^^^^^^^^ + +... + +Objective-C Language Changes in Clang +------------------------------------- + +... + +Internal API Changes +-------------------- + +These are major API changes that have happened since the 3.2 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. + +API change 1 +^^^^^^^^^^^^ + +... + +Python Binding Changes +---------------------- + +The following methods have been added: + +- ... + +Significant Known Problems +========================== + +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 +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 +tree. + +If you have any questions or comments about Clang, please feel free to +contact us via the `mailing +list <http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev>`_. diff --git a/clang/docs/index.rst b/clang/docs/index.rst index 89fc0d6c27b..038e943b1eb 100644 --- a/clang/docs/index.rst +++ b/clang/docs/index.rst @@ -33,6 +33,7 @@ progress. This page will get filled out with docs soon... DriverInternals BlockLanguageSpec ObjectiveCLiterals + ReleaseNotes Indices and tables ================== |
