[llvm] r368932 - [docs] Fix sphinx doc generation errors
Jordan Rupprecht via llvm-commits
llvm-commits at lists.llvm.org
Wed Aug 14 15:18:01 PDT 2019
Author: rupprecht
Date: Wed Aug 14 15:18:01 2019
New Revision: 368932
URL: http://llvm.org/viewvc/llvm-project?rev=368932&view=rev
Log:
[docs] Fix sphinx doc generation errors
Summary:
Errors fixed:
- GettingStarted: Duplicate explicit target name: "cmake"
- GlobalISel: Unexpected indentation
- LoopTerminology: Explicit markup ends without a blank line; unexpected unindent
- ORCv2: Definition list ends without a blank line; unexpected unindent
- Misc: document isn't included in any toctree
Verified that a clean docs build (`rm -rf docs/ && ninja docs-llvm-html`) passes with no errors. Spot checked the individual pages to make sure they look OK.
Reviewers: thakis, dsanders
Reviewed By: dsanders
Subscribers: arphaman, llvm-commits, lhames, rovka, dsanders, reames
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D66183
Modified:
llvm/trunk/docs/GettingStarted.rst
llvm/trunk/docs/GlobalISel.rst
llvm/trunk/docs/LoopTerminology.rst
llvm/trunk/docs/ORCv2.rst
llvm/trunk/docs/index.rst
llvm/trunk/docs/tutorial/index.rst
Modified: llvm/trunk/docs/GettingStarted.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.rst?rev=368932&r1=368931&r2=368932&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.rst (original)
+++ llvm/trunk/docs/GettingStarted.rst Wed Aug 14 15:18:01 2019
@@ -95,7 +95,7 @@ Here's the short story for getting up an
``make -j NNN`` (with an appropriate value of NNN, e.g. number of CPUs
you have.)
- * For more information see `CMake <CMake.html>`_
+ * For more information see `CMake <CMake.html>`__
* If you get an "internal compiler error (ICE)" or test failures, see
`below`_.
@@ -169,7 +169,7 @@ uses the package and provides other deta
=========================================================== ============ ==========================================
Package Version Notes
=========================================================== ============ ==========================================
-`CMake <http://cmake.org/>`_ >=3.4.3 Makefile/workspace generator
+`CMake <http://cmake.org/>`__ >=3.4.3 Makefile/workspace generator
`GCC <http://gcc.gnu.org/>`_ >=5.1.0 C/C++ compiler\ :sup:`1`
`python <http://www.python.org/>`_ >=2.7 Automated test suite\ :sup:`2`
`zlib <http://zlib.net>`_ >=1.2.3.4 Compression library\ :sup:`3`
Modified: llvm/trunk/docs/GlobalISel.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GlobalISel.rst?rev=368932&r1=368931&r2=368932&view=diff
==============================================================================
--- llvm/trunk/docs/GlobalISel.rst (original)
+++ llvm/trunk/docs/GlobalISel.rst Wed Aug 14 15:18:01 2019
@@ -573,11 +573,13 @@ connect operations with different type s
since G_ANYEXT doesn't define the value of the additional bits and G_TRUNC is
discarding bits. The other conversions can be lowered into G_ANYEXT/G_TRUNC
with some additional operations that are subject to further legalization. For
-example, G_SEXT can lower to:
+example, G_SEXT can lower to::
+
%1 = G_ANYEXT %0
%2 = G_CONSTANT ...
%3 = G_SHL %1, %2
%4 = G_ASHR %3, %2
+
and the G_CONSTANT/G_SHL/G_ASHR can further lower to other operations or target
instructions. Similarly, G_FPEXT has no legality requirement since it can lower
to a G_ANYEXT followed by a target instruction.
@@ -622,6 +624,7 @@ The rules for G_ANYEXT, G_MERGE_VALUES,
G_BUILD_VECTOR_TRUNC, G_CONCAT_VECTORS, G_UNMERGE_VALUES, G_PTRTOINT, and
G_INTTOPTR have already been noted above. In addition to those, the following
operations have requirements:
+
* At least one G_IMPLICIT_DEF must be legal. This is usually trivial as it
requires no code to be selected.
* G_PHI must be legal for all types in the producer and consumer typesets. This
Modified: llvm/trunk/docs/LoopTerminology.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/LoopTerminology.rst?rev=368932&r1=368931&r2=368932&view=diff
==============================================================================
--- llvm/trunk/docs/LoopTerminology.rst (original)
+++ llvm/trunk/docs/LoopTerminology.rst Wed Aug 14 15:18:01 2019
@@ -1,4 +1,5 @@
.. _loop-terminology:
+
===========================================
LLVM Loop Terminology (and Canonical Forms)
===========================================
Modified: llvm/trunk/docs/ORCv2.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/ORCv2.rst?rev=368932&r1=368931&r2=368932&view=diff
==============================================================================
--- llvm/trunk/docs/ORCv2.rst (original)
+++ llvm/trunk/docs/ORCv2.rst Wed Aug 14 15:18:01 2019
@@ -476,24 +476,21 @@ or creating any Modules attached to it.
.. code-block:: c++
+ ThreadSafeContext TSCtx(llvm::make_unique<LLVMContext>());
- ThreadSafeContext TSCtx(llvm::make_unique<LLVMContext>());
+ ThreadPool TP(NumThreads);
+ JITStack J;
- ThreadPool TP(NumThreads);
- JITStack J;
+ for (auto &ModulePath : ModulePaths) {
+ TP.async(
+ [&]() {
+ auto Lock = TSCtx.getLock();
+ auto M = loadModuleOnContext(ModulePath, TSCtx.getContext());
+ J.addModule(ThreadSafeModule(std::move(M), TSCtx));
+ });
+ }
- for (auto &ModulePath : ModulePaths) {
- TP.async(
- [&]() {
- auto Lock = TSCtx.getLock();
-
- auto M = loadModuleOnContext(ModulePath, TSCtx.getContext());
-
- J.addModule(ThreadSafeModule(std::move(M), TSCtx));
- });
- }
-
- TP.wait();
+ TP.wait();
To make exclusive access to Modules easier to manage the ThreadSafeModule class
provides a convenince function, ``withModuleDo``, that implicitly (1) locks the
Modified: llvm/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/index.rst?rev=368932&r1=368931&r2=368932&view=diff
==============================================================================
--- llvm/trunk/docs/index.rst (original)
+++ llvm/trunk/docs/index.rst Wed Aug 14 15:18:01 2019
@@ -274,6 +274,7 @@ For API clients and LLVM developers.
BlockFrequencyTerminology
BranchWeightMetadata
Bugpoint
+ BugpointRedesign
CodeGenerator
ExceptionHandling
AddingConstrainedIntrinsics
@@ -313,6 +314,7 @@ For API clients and LLVM developers.
CFIVerify
SpeculativeLoadHardening
StackSafetyAnalysis
+ LoopTerminology
:doc:`WritingAnLLVMPass`
Information on how to write LLVM transformations and analyses.
@@ -363,6 +365,9 @@ For API clients and LLVM developers.
Automatic bug finder and test-case reducer description and usage
information.
+:doc:`BugpointRedesign`
+ Design doc for a redesign of the Bugpoint tool.
+
:doc:`BitCodeFormat`
This describes the file format and encoding used for LLVM "bc" files.
@@ -461,6 +466,9 @@ For API clients and LLVM developers.
This document describes the design of the stack safety analysis of local
variables.
+:doc:`LoopTerminology`
+ A document describing Loops and associated terms as used in LLVM.
+
Development Process Documentation
=================================
Modified: llvm/trunk/docs/tutorial/index.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/tutorial/index.rst?rev=368932&r1=368931&r2=368932&view=diff
==============================================================================
--- llvm/trunk/docs/tutorial/index.rst (original)
+++ llvm/trunk/docs/tutorial/index.rst Wed Aug 14 15:18:01 2019
@@ -10,9 +10,10 @@ Kaleidoscope: Implementing a Language wi
:glob:
:numbered:
-#. `My First Language Frontend with LLVM Tutorial <MyFirstLanguageFrontend/index.html>`_
- This is the "Kaleidoscope" Language tutorial, showing how to implement
- a simple language using LLVM components in C++.
+ MyFirstLanguageFrontend/index
+
+This is the "Kaleidoscope" Language tutorial, showing how to implement a simple
+language using LLVM components in C++.
Kaleidoscope: Implementing a Language with LLVM in Objective Caml
=================================================================
More information about the llvm-commits
mailing list