[llvm] r202603 - [docs] Fix some Sphinx warnings.

Sean Silva silvas at purdue.edu
Sat Mar 1 16:21:43 PST 2014


Author: silvas
Date: Sat Mar  1 18:21:42 2014
New Revision: 202603

URL: http://llvm.org/viewvc/llvm-project?rev=202603&view=rev
Log:
[docs] Fix some Sphinx warnings.

The docs now build cleanly. Yay!

The following warnings were fixed:

/home/sean/pg/llvm/llvm/docs/HowToReleaseLLVM.rst:364: WARNING: Enumerated list ends without a blank line; unexpected unindent.
/home/sean/pg/llvm/llvm/docs/InAlloca.rst:: WARNING: document isn't included in any toctree

/home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short.

Supported C++11 Language and Library Features
-------------------------------------------
/home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short.

Supported C++11 Language and Library Features
-------------------------------------------
/home/sean/pg/llvm/llvm/docs/GettingStarted.rst:185: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/sean/pg/llvm/llvm/docs/GettingStarted.rst:565: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/sean/pg/llvm/llvm/docs/GettingStarted.rst:567: WARNING: Block quote ends without a blank line; unexpected unindent.

Modified:
    llvm/trunk/docs/CodingStandards.rst
    llvm/trunk/docs/GettingStarted.rst
    llvm/trunk/docs/HowToReleaseLLVM.rst
    llvm/trunk/docs/index.rst

Modified: llvm/trunk/docs/CodingStandards.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CodingStandards.rst?rev=202603&r1=202602&r2=202603&view=diff
==============================================================================
--- llvm/trunk/docs/CodingStandards.rst (original)
+++ llvm/trunk/docs/CodingStandards.rst Sat Mar  1 18:21:42 2014
@@ -82,7 +82,7 @@ avoided. Also, there is much more detail
   http://llvm.org/docs/ProgrammersManual.html
 
 Supported C++11 Language and Library Features
--------------------------------------------
+---------------------------------------------
 
 While LLVM, Clang, and LLD use C++11, not all features are available in all of
 the toolchains which we support. The set of features supported for use in LLVM

Modified: llvm/trunk/docs/GettingStarted.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.rst?rev=202603&r1=202602&r2=202603&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.rst (original)
+++ llvm/trunk/docs/GettingStarted.rst Sat Mar  1 18:21:42 2014
@@ -182,7 +182,7 @@ Package
    #. If you want to make changes to the configure scripts, you will need GNU
       autoconf (2.60), and consequently, GNU M4 (version 1.4 or higher). You
       will also need automake (1.9.6). We only use aclocal from that package.
-#.Optional, adds compression / uncompression capabilities to selected LLVM
+   #. Optional, adds compression / uncompression capabilities to selected LLVM
       tools.
 
 Additionally, your compilation host is expected to have the usual plethora of
@@ -561,8 +561,9 @@ Then, your .git/config should have [imap
         pass = himitsu!
         port = 993
         sslverify = false
-  ;
-in English folder = "[Gmail]/Drafts"; example for Japanese, "Modified UTF-7" encoded.
+  ; in English
+        folder = "[Gmail]/Drafts"
+  ; example for Japanese, "Modified UTF-7" encoded.
         folder = "[Gmail]/&Tgtm+DBN-"
   ; example for Traditional Chinese
         folder = "[Gmail]/&g0l6Pw-"

Modified: llvm/trunk/docs/HowToReleaseLLVM.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/HowToReleaseLLVM.rst?rev=202603&r1=202602&r2=202603&view=diff
==============================================================================
--- llvm/trunk/docs/HowToReleaseLLVM.rst (original)
+++ llvm/trunk/docs/HowToReleaseLLVM.rst Sat Mar  1 18:21:42 2014
@@ -361,6 +361,7 @@ Below are the rules regarding patching t
 
 #. For dot releases all patches must mantain both API and ABI compatibility with
    the previous major release.  Only bugfixes will be accepted.
+
 Release Final Tasks
 -------------------
 

Modified: llvm/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/index.rst?rev=202603&r1=202602&r2=202603&view=diff
==============================================================================
--- llvm/trunk/docs/index.rst (original)
+++ llvm/trunk/docs/index.rst Sat Mar  1 18:21:42 2014
@@ -235,6 +235,7 @@ For API clients and LLVM developers.
    HowToUseAttributes
    NVPTXUsage
    StackMaps
+   InAlloca
 
 :doc:`WritingAnLLVMPass`
    Information on how to write LLVM transformations and analyses.





More information about the llvm-commits mailing list