[PATCH] D122719: Improved Documentation Inclusivity

Priyansh Singh via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Mar 31 01:13:17 PDT 2022


ps-19 updated this revision to Diff 419359.
ps-19 added a comment.

Clang Formatting Checked


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D122719

Files:
  README.md


Index: README.md
===================================================================
--- README.md
+++ README.md
@@ -11,7 +11,7 @@
 
 ## Getting Started with the LLVM System
 
-Taken from https://llvm.org/docs/GettingStarted.html.
+Taken from [here](https://llvm.org/docs/GettingStarted.html).
 
 ### Overview
 
@@ -20,10 +20,10 @@
 The LLVM project has multiple components. The core of the project is
 itself called "LLVM". This contains all of the tools, libraries, and header
 files needed to process intermediate representations and convert them into
-object files.  Tools include an assembler, disassembler, bitcode analyzer, and
-bitcode optimizer.  It also contains basic regression tests.
+object files. Tools include an assembler, disassembler, bitcode analyzer, and
+bitcode optimizer. It also contains basic regression tests.
 
-C-like languages use the [Clang](http://clang.llvm.org/) front end.  This
+C-like languages use the [Clang](http://clang.llvm.org/) frontend. This
 component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode
 -- and from there into object files, using LLVM.
 
@@ -100,13 +100,13 @@
         * CMake will generate targets for each tool and library, and most
           LLVM sub-projects generate their own ``check-<project>`` target.
 
-        * Running a serial build will be **slow**.  To improve speed, try running a
+        * Running a serial build will be **slow**. To improve speed, try running a
           parallel build.  That's done by default in Ninja; for ``make``, use the option
           ``-j NNN``, where ``NNN`` is the number of parallel jobs to run.
           In most cases, you get the best performance if you specify the number of CPU threads you have.
           On some Unix systems, you can specify this with ``-j$(nproc)``.
 
-      * For more information see [CMake](https://llvm.org/docs/CMake.html)
+      * For more information see [CMake](https://llvm.org/docs/CMake.html).
 
 Consult the
 [Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D122719.419359.patch
Type: text/x-patch
Size: 2080 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220331/56cec133/attachment.bin>


More information about the llvm-commits mailing list