Skip to content

Commit e364ddf

Browse files
authored
[docs] Fix formatting issues in MyFirstTypoFix (#77527)
Fix various formatting issues in MyFirstTypoFix.
1 parent c9124ad commit e364ddf

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

llvm/docs/MyFirstTypoFix.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ It may take a while to download!
9191
$ git clone https://github.com/llvm/llvm-project.git
9292
9393
This will create a directory "llvm-project" with all of the source
94-
code.(Checking out anonymously is OK - pushing commits uses a different
95-
mechanism, as we'll see later)
94+
code. (Checking out anonymously is OK - pushing commits uses a different
95+
mechanism, as we'll see later.)
9696

9797
Configure your workspace
9898
------------------------
@@ -142,21 +142,21 @@ Let's break down that last command a little:
142142
- The two **-D** flags set CMake variables, which override
143143
CMake/project defaults:
144144

145-
- **CMAKE\ BUILD\ TYPE=Release**: build in optimized mode, which is
146-
(surprisingly) the fastest option.
145+
- **CMAKE_BUILD_TYPE=Release**: build in optimized mode, which is
146+
(surprisingly) the fastest option.
147147

148-
If you want to run under a debugger, you should use the default Debug
149-
(which is totally unoptimized, and will lead to >10x slower test
150-
runs) or RelWithDebInfo which is a halfway point.
151-
**CMAKE\ BUILD\ TYPE** affects code generation only, assertions are
152-
on by default regardless! **LLVM\ ENABLE\ ASSERTIONS=Off** disables
153-
them.
148+
If you want to run under a debugger, you should use the default Debug
149+
(which is totally unoptimized, and will lead to >10x slower test
150+
runs) or RelWithDebInfo which is a halfway point.
151+
**CMAKE_BUILD_TYPE** affects code generation only, assertions are
152+
on by default regardless! **LLVM_ENABLE_ASSERTIONS=Off** disables
153+
them.
154154

155-
- **LLVM\ ENABLE\ PROJECTS=clang** : this lists the LLVM subprojects
156-
you are interested in building, in addition to LLVM itself. Multiple
157-
projects can be listed, separated by semicolons, such as "clang;
158-
lldb".In this example, we'll be making a change to Clang, so we
159-
should build it.
155+
- **LLVM_ENABLE_PROJECTS=clang**: this lists the LLVM subprojects
156+
you are interested in building, in addition to LLVM itself. Multiple
157+
projects can be listed, separated by semicolons, such as "clang;
158+
lldb".In this example, we'll be making a change to Clang, so we
159+
should build it.
160160

161161
Finally, create a symlink (or a copy) of
162162
llvm-project/build/compile-commands.json into llvm-project/:
@@ -225,7 +225,7 @@ the message in your favorite editor:
225225
$ vi ../clang/include/clang/Basic/DiagnosticSemaKinds.td
226226
227227
Find the message (it should be under
228-
warn\ *infinite*\ recursive_function)Change the message to "in order to
228+
``warn_infinite_recursive_function``). Change the message to "in order to
229229
understand recursion, you must first understand recursion".
230230

231231

0 commit comments

Comments
 (0)