[llvm] [Doc] Improve documentation for JITLink. (PR #109163)

[Xing Guo via llvm-commits]

https://github.com/higuoxing updated https://github.com/llvm/llvm-project/pull/109163

>From 8cdc15f10d436fa80a03c75e658096e44f2b2453 Mon Sep 17 00:00:00 2001
From: Xing Guo <higuoxing at gmail.com>
Date: Wed, 18 Sep 2024 15:25:27 +0800
Subject: [PATCH 1/2] [Doc] Improve documentation for JITLink.

This patch improves the documentation for JITLink by fixing some typos,
correcting indentations and fixing out-dated code examples.
---
 llvm/docs/JITLink.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/llvm/docs/JITLink.rst b/llvm/docs/JITLink.rst
index b0a0dc77880dfd..525cba1f48b15f 100644
--- a/llvm/docs/JITLink.rst
+++ b/llvm/docs/JITLink.rst
@@ -11,7 +11,7 @@ Introduction
 This document aims to provide a high-level overview of the design and API
 of the JITLink library. It assumes some familiarity with linking and
 relocatable object files, but should not require deep expertise. If you know
-what a section, symbol, and relocation are you should find this document
+what a section, symbol, and relocation then you should find this document
 accessible. If it is not, please submit a patch (:doc:`Contributing`) or file a
 bug (:doc:`HowToSubmitABug`).
 
@@ -56,7 +56,7 @@ and optimizations that were not possible under MCJIT or RuntimeDyld.
 ObjectLinkingLayer Plugins
 --------------------------
 
-The ``ObjectLinkingLayer::Plugin`` class  provides the following  methods:
+The ``ObjectLinkingLayer::Plugin`` class provides the following methods:
 
 * ``modifyPassConfig`` is called each time a LinkGraph is about to be linked. It
   can be overridden to install JITLink *Passes* to run during the link process.
@@ -64,7 +64,7 @@ The ``ObjectLinkingLayer::Plugin`` class  provides the following  methods:
   .. code-block:: c++
 
     void modifyPassConfig(MaterializationResponsibility &MR,
-                          const Triple &TT,
+                          jitlink::LinkGraph &G,
                           jitlink::PassConfiguration &Config)
 
 * ``notifyLoaded`` is called before the link begins, and can be overridden to
@@ -97,7 +97,7 @@ The ``ObjectLinkingLayer::Plugin`` class  provides the following  methods:
 
   .. code-block:: c++
 
-    Error notifyRemovingResources(ResourceKey K)
+    Error notifyRemovingResources(JITDylib &JD, ResourceKey K)
 
 * ``notifyTransferringResources`` is called if/when a request is made to
   transfer tracking of any resources associated with ``ResourceKey``
@@ -105,7 +105,7 @@ The ``ObjectLinkingLayer::Plugin`` class  provides the following  methods:
 
   .. code-block:: c++
 
-    void notifyTransferringResources(ResourceKey DstKey,
+    void notifyTransferringResources(JITDylib &JD, ResourceKey DstKey,
                                      ResourceKey SrcKey)
 
 Plugin authors are required to implement the ``notifyFailed``,
@@ -126,7 +126,7 @@ calling the ``addPlugin`` method [1]_. E.g.
 
     // Add passes to print the set of defined symbols after dead-stripping.
     void modifyPassConfig(MaterializationResponsibility &MR,
-                          const Triple &TT,
+                          jitlink::LinkGraph &G,
                           jitlink::PassConfiguration &Config) override {
       Config.PostPrunePasses.push_back([this](jitlink::LinkGraph &G) {
         return printAllSymbols(G);
@@ -137,10 +137,10 @@ calling the ``addPlugin`` method [1]_. E.g.
     Error notifyFailed(MaterializationResponsibility &MR) override {
       return Error::success();
     }
-    Error notifyRemovingResources(ResourceKey K) override {
+    Error notifyRemovingResources(JITDylib &JD, ResourceKey K) override {
       return Error::success();
     }
-    void notifyTransferringResources(ResourceKey DstKey,
+    void notifyTransferringResources(JITDylib &JD, ResourceKey DstKey,
                                      ResourceKey SrcKey) override {}
 
     // JITLink pass to print all defined symbols in G.
@@ -407,7 +407,7 @@ and utilities relevant to the linking process:
   * ``getPointerSize`` returns the size of a pointer (in bytes) in the executor
     process.
 
-  * ``getEndinaness`` returns the endianness of the executor process.
+  * ``getEndianness`` returns the endianness of the executor process.
 
   * ``allocateString`` copies data from a given ``llvm::Twine`` into the
     link graph's internal allocator. This can be used to ensure that content
@@ -802,7 +802,7 @@ for them by an ``ObjectLinkingLayer`` instance, but they can be created manually
    ``ObjectLinkingLayer`` usually creates ``LinkGraphs``.
 
   #. ``createLinkGraph_<Object-Format>_<Architecture>`` can be used when
-      both the object format and architecture are known ahead of time.
+     both the object format and architecture are known ahead of time.
 
   #. ``createLinkGraph_<Object-Format>`` can be used when the object format is
      known ahead of time, but the architecture is not. In this case the

>From 7f7d2664b740d7ed1c12b6a0f88d106e8c6fafc3 Mon Sep 17 00:00:00 2001
From: Xing Guo <higuoxing+github at gmail.com>
Date: Thu, 19 Sep 2024 07:35:36 +0800
Subject: [PATCH 2/2] Address review comments.

---
 llvm/docs/JITLink.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/llvm/docs/JITLink.rst b/llvm/docs/JITLink.rst
index 525cba1f48b15f..89027123f47500 100644
--- a/llvm/docs/JITLink.rst
+++ b/llvm/docs/JITLink.rst
@@ -11,7 +11,7 @@ Introduction
 This document aims to provide a high-level overview of the design and API
 of the JITLink library. It assumes some familiarity with linking and
 relocatable object files, but should not require deep expertise. If you know
-what a section, symbol, and relocation then you should find this document
+what a section, symbol, and relocation are then you should find this document
 accessible. If it is not, please submit a patch (:doc:`Contributing`) or file a
 bug (:doc:`HowToSubmitABug`).