[llvm] [docs] Fix formatting issues in MyFirstTypoFix (PR #77527)

Nicholas Mosier via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 9 13:35:52 PST 2024


https://github.com/nmosier created https://github.com/llvm/llvm-project/pull/77527

Fix various formatting issues in MyFirstTypoFix.

>From 5d02ec7d3d3ffe94b16852384e9bfa57305b986e Mon Sep 17 00:00:00 2001
From: Nicholas Mosier <nmosier at stanford.edu>
Date: Tue, 9 Jan 2024 21:28:47 +0000
Subject: [PATCH] [docs] Fix formatting issues in MyFirstTypoFix

Fix various formatting issues in MyFirstTypoFix.
---
 llvm/docs/MyFirstTypoFix.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index b6040af756e265..b8d34733122c11 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -91,8 +91,8 @@ It may take a while to download!
    $ git clone https://github.com/llvm/llvm-project.git
 
 This will create a directory "llvm-project" with all of the source
-code.(Checking out anonymously is OK - pushing commits uses a different
-mechanism, as we'll see later)
+code. (Checking out anonymously is OK - pushing commits uses a different
+mechanism, as we'll see later.)
 
 Configure your workspace
 ------------------------
@@ -142,21 +142,21 @@ Let's break down that last command a little:
 -  The two **-D** flags set CMake variables, which override
    CMake/project defaults:
 
--  **CMAKE\ BUILD\ TYPE=Release**: build in optimized mode, which is
-   (surprisingly) the fastest option.
+    -  **CMAKE_BUILD_TYPE=Release**: build in optimized mode, which is
+       (surprisingly) the fastest option.
 
-   If you want to run under a debugger, you should use the default Debug
-   (which is totally unoptimized, and will lead to >10x slower test
-   runs) or RelWithDebInfo which is a halfway point.
-   **CMAKE\ BUILD\ TYPE** affects code generation only, assertions are
-   on by default regardless! **LLVM\ ENABLE\ ASSERTIONS=Off** disables
-   them.
+       If you want to run under a debugger, you should use the default Debug
+       (which is totally unoptimized, and will lead to >10x slower test
+       runs) or RelWithDebInfo which is a halfway point.
+       **CMAKE_BUILD_TYPE** affects code generation only, assertions are
+       on by default regardless! **LLVM_ENABLE_ASSERTIONS=Off** disables
+       them.
 
--  **LLVM\ ENABLE\ PROJECTS=clang** : this lists the LLVM subprojects
-   you are interested in building, in addition to LLVM itself. Multiple
-   projects can be listed, separated by semicolons, such as "clang;
-   lldb".In this example, we'll be making a change to Clang, so we
-   should build it.
+    -  **LLVM_ENABLE_PROJECTS=clang**: this lists the LLVM subprojects
+       you are interested in building, in addition to LLVM itself. Multiple
+       projects can be listed, separated by semicolons, such as "clang;
+       lldb".In this example, we'll be making a change to Clang, so we
+       should build it.
 
 Finally, create a symlink (or a copy) of
 llvm-project/build/compile-commands.json into llvm-project/:
@@ -225,7 +225,7 @@ the message in your favorite editor:
    $ vi ../clang/include/clang/Basic/DiagnosticSemaKinds.td
 
 Find the message (it should be under
-warn\ *infinite*\ recursive_function)Change the message to "in order to
+``warn_infinite_recursive_function``). Change the message to "in order to
 understand recursion, you must first understand recursion".
 
 



More information about the llvm-commits mailing list