[PATCH] D156858: Add Documentation for Execution Results Handling in Clang-REPL

[QuillPusher via Phabricator via cfe-commits]

QuillPusher requested changes to this revision.
QuillPusher added a comment.
This revision now requires changes to proceed.

added minor changes based on Vassil's review during docs meeting



================
Comment at: clang/docs/ClangRepl.rst:220-230
+
+:doc:`ExecutionResultsHandling` helps extend the Clang-REPL functionality by
+creating an interface between the execution results of a program and the compiled
+program. Following are its main components:
+
+- Capture Execution Results: This feature helps capture the execution results
+  of a program and bring them back to the compiled program.
----------------
As per Vassil's comment below, please move all the Execution Results handling text in the main Clang-Repl doc instead of a separate ExecutionResultsHandling document

So this paragraph can be removed and all the content from the ExecutionResultsHandling.rst can be included here in this ClangRepl.rst document


================
Comment at: clang/docs/ExecutionResultsHandling.rst:119-127
+
+.. code-block:: console
+
+    for (Decl *D : DGR)
+      if (auto *TSD = llvm::dyn_cast<TopLevelStmtDecl>(D);
+          TSD && TSD->isSemiMissing())
+        TSD->setStmt(Interp.SynthesizeExpr(cast<Expr>(TSD->getStmt())));
----------------
Add note before code snippet

**Note:** Following is a sample code snippet. Actual code may vary over time.


================
Comment at: clang/docs/ExecutionResultsHandling.rst:237-256
+.. code-block:: console
+
+    void Value::print(llvm::raw_ostream &Out) const {
+    assert(OpaqueType != nullptr && "Can't print default Value");
+
+    if (getType()->isVoidType() || !isValid())
+        return;
----------------
please remove this code block, it is not needed


================
Comment at: clang/docs/index.rst:96
    ClangRepl
+   ExecutionResultsHandling
 
----------------
v.g.vassilev wrote:
> We should probably move that under `ClangRepl`.
> We should probably move that under `ClangRepl`.

@Krishna-13-cyber I have commented above, where the excerpt paragraph in CalngRepl.rst can be removed and all content from ExecutionResultsHandling.rst can be included (and remove file ExecutionResultsHandling.rst after that)


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D156858/new/

https://reviews.llvm.org/D156858