[PATCH] D122719: Improved Documentation Inclusivity

[Priyansh Singh via Phabricator via llvm-commits]

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

Removed a grammatical mistake.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D122719

Files:
  README.md
  patch_file.patch


Index: patch_file.patch
===================================================================
--- /dev/null
+++ patch_file.patch
@@ -0,0 +1,62 @@
+diff --git a/README.md b/README.md
+index 40284fed5b98..d5ae416b5196 100644
+--- a/README.md
++++ b/README.md
+@@ -11,7 +11,7 @@ take a look at the
+ 
+ ## 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 @@ Welcome to the LLVM project!
+ 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.
+ 
+@@ -33,7 +33,7 @@ the [LLD linker](https://lld.llvm.org), and more.
+ 
+ ### Getting the Source Code and Building LLVM
+ 
+-The LLVM Getting Started documentation may be out of date.  The [Clang
++The LLVM Getting Started documentation may be out of date. The [Clang
+ Getting Started](http://clang.llvm.org/get_started.html) page might have more
+ accurate information.
+ 
+@@ -55,7 +55,7 @@ This is an example work-flow and configuration to get and build the LLVM source:
+         Some common build system generators are:
+ 
+         * ``Ninja`` --- for generating [Ninja](https://ninja-build.org)
+-          build files. Most llvm developers use Ninja.
++          build files. Most llvm developers uses Ninja.
+         * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
+         * ``Visual Studio`` --- for generating Visual Studio projects and
+           solutions.
+@@ -100,13 +100,13 @@ This is an example work-flow and configuration to get and build the LLVM source:
+         * 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
+-          parallel build.  That's done by default in Ninja; for ``make``, use the option
++        * 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)
Index: README.md
===================================================================
--- README.md
+++ README.md
@@ -55,7 +55,7 @@
         Some common build system generators are:
 
         * ``Ninja`` --- for generating [Ninja](https://ninja-build.org)
-          build files. Most llvm developers uses Ninja.
+          build files. Most llvm developers use Ninja.
         * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
         * ``Visual Studio`` --- for generating Visual Studio projects and
           solutions.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D122719.419103.patch
Type: text/x-patch
Size: 3934 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220330/419da5e7/attachment.bin>