[llvm] d91cfce - [docs][JITLink] More attempted fixes for formatting issues in the JITLink doc.

[Lang Hames via llvm-commits]

Author: Lang Hames
Date: 2021-02-24T21:41:27+11:00
New Revision: d91cfcebbde502c01922b10f1ce39e4196e95223

URL: https://github.com/llvm/llvm-project/commit/d91cfcebbde502c01922b10f1ce39e4196e95223
DIFF: https://github.com/llvm/llvm-project/commit/d91cfcebbde502c01922b10f1ce39e4196e95223.diff

LOG: [docs][JITLink] More attempted fixes for formatting issues in the JITLink doc.

Try using the literal domain for `ObjectLinkingLayer::Plugin` and literal
blocks for multi-line method names.

Added: 
    

Modified: 
    llvm/docs/JITLink.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/JITLink.rst b/llvm/docs/JITLink.rst
index 477a3f0aff82..a224abc92d0c 100644
--- a/llvm/docs/JITLink.rst
+++ b/llvm/docs/JITLink.rst
@@ -47,7 +47,7 @@ Either way, when an object is emitted the ObjectLinkingLayer constructs a
 ``link`` function.
 
 ``ObjectLinkingLayer`` provides a plugin API,
-:cpp:expr:`ObjectLinkingLayer::Plugin`, which users can subclass in order to
+:literal:`ObjectLinkingLayer::Plugin`, which users can subclass in order to
 inspect and modify `LinkGraph`s at link time, and react to important JIT events
 (such as an object being emitted into target memory). This enables many features
 and optimizations that were not possible under MCJIT or RuntimeDyld.
@@ -57,7 +57,9 @@ ObjectLinkingLayer Plugins
 
 The ``ObjectLinkingLayer::Plugin`` class  provides the following  methods:
 
-* ``virtual void modifyPassConfig(MaterializationResponsibility &MR,
+* ::
+
+    virtual void modifyPassConfig(MaterializationResponsibility &MR,
                                   const Triple &TT,
                                   jitlink::PassConfiguration &Config)``
 
@@ -85,8 +87,11 @@ The ``ObjectLinkingLayer::Plugin`` class  provides the following  methods:
   ``notifyTransferringResources`` should be implemented, or neither should be.
   Implementing one but not the other will lead to resource management bugs.
 
-* ``virtual void notifyTransferringResources(ResourceKey DstKey,
-                                             ResourceKey SrcKey)``
+* ::
+
+    virtual void notifyTransferringResources(ResourceKey DstKey,
+                                             ResourceKey SrcKey)
+
   Called if/when a request is made to reassociate resources from *SrcKey* to
   *DstKey*. Override to update the plugin's resource tracking maps (if any).
   Note: Either both of ``notifyRemovingResources`` and