Improved Documentation Inclusivity

[ps-19]

Summary

Primary Aim Of the Patch is:

• Added more visibility in docs.
• Removed Errors and grammatical mistakes.
• Removed extra spaces and tabs created to make sample code and command error-less and concise.

Dear sir/mam,
I am new to LLVM and contribution here is complicated and different. I am working on a issue, so trying to understand, how to submit a patch using this contribution. Kindly merge the request. I am really good at coding i am coding since 14 yrs age, development and open source.
https://ps-19.github.io/Resume
https://github.com/fabric8io/kubernetes-client/pull/3220
https://github.com/CleverRaven/Cataclysm-DDA/pull/51435
https://github.com/cherrypy/cherrypy/pull/1918
etc....

[ps-19]

My First Contribution to LLVM please merge the patch.

[ktkachov]

README.md

58

I think "Most LLVM developers use Ninja" is the correct English grammar here. "Uses" would have been used for singular "developer"

[ps-19]

This comment was removed by ps-19.

[ps-19]

This comment was removed by ps-19.

[ps-19]

Removed a grammatical mistake.

[ps-19]

Done Now!!

[aaron.ballman]

In D122719#3416297, @ps-19 wrote:

what should i do now? Close this patch and resend patch as a separate file again. I seriously can not understand how to edit patch?

Once you've made your changes and put them in a new patch, you can update this review with the new patch content by clicking the Update Diff link on the upper-right of this review (to the right of the Details section).

(We'll see if the picture I uploaded works or not, but it circles the button you're looking for.)

[ps-19]

In D122719#3416324, @aaron.ballman wrote:

In D122719#3416297, @ps-19 wrote:

what should i do now? Close this patch and resend patch as a separate file again. I seriously can not understand how to edit patch?

Once you've made your changes and put them in a new patch, you can update this review with the new patch content by clicking the Update Diff link on the upper-right of this review (to the right of the Details section).

(We'll see if the picture I uploaded works or not, but it circles the button you're looking for.)

Sir i did that!! Thank you for your kind reply. I think now build is failing.

[aaron.ballman]

In D122719#3416325, @ps-19 wrote:

In D122719#3416324, @aaron.ballman wrote:

In D122719#3416297, @ps-19 wrote:

what should i do now? Close this patch and resend patch as a separate file again. I seriously can not understand how to edit patch?

Once you've made your changes and put them in a new patch, you can update this review with the new patch content by clicking the Update Diff link on the upper-right of this review (to the right of the Details section).

(We'll see if the picture I uploaded works or not, but it circles the button you're looking for.)

Sir i did that!! Thank you for your kind reply. I think now build is failing.

It seems that you uploaded the patch directly somehow (patch_file.patch was added to this review). Btw, https://llvm.org/docs/Phabricator.html#requesting-a-review-via-the-web-interface has instructions on how to update a patch, which may help.

[xbolva00]

In D122719#3416274, @ps-19 wrote:

Sir please accept this patch i am working constantly 16 hr for consecutive 3 days to install and submit patch.

Please choose better words next time, to avoid feeling of pushing people to do something.

[ps-19]

Minor changes.

[ps-19]

Minor Changes.

[ps-19]

can anyone help me to understand why build is failing?

[aaron.ballman]

In D122719#3416379, @ps-19 wrote:

can anyone help me to understand why build is failing?

It looks like there are two issues:

1. patch_file.patch is included in the patch contents when it should be the contents for the review.
2. README.md doesn't apply cleanly: https://buildkite.com/llvm-project/diff-checks/builds/96700#9a5d304b-fa5b-4cba-a134-e16005c8ec9d

You can see the failures by clicking on the patch application failed link in Build Status to get to the link above.

[xbolva00]

Instead of https://reviews.llvm.org/D122727 you could just continue here with new patch revision. It would be better for you to learn things properly, instead of doing easy but incorrect ways how to solve some issues. :)

If you want learn more about phabricator, you can create new empty patch review without reviewers where you can play and learn things.

[ps-19]

In D122719#3416495, @xbolva00 wrote:

Instead of https://reviews.llvm.org/D122727 you could just continue here with new patch revision. It would be better for you to learn things properly, instead of doing easy but incorrect ways how to solve some issues. :)

If you want learn more about phabricator, you can create new empty patch review without reviewers where you can play and learn things.

once my patch got merged i will surely start doing that, but right now i have to work on an issue assignment to me as soon as possible.
Thank you.

[ps-19]

Last Change.

[xbolva00]

Looks fine now

[ps-19]

sir can you please merge it now. I am going to work on issue#53178 .

[ps-19]

Clang Formatting Checked

[aaron.ballman]

The changes LGTM, thank you for them! What name and email address would you like me to use for patch attribution?

[ps-19]

Name: Priyansh Singh
Email: [e-mail]

[ps-19]

https://reviews.llvm.org/p/aaron.ballman

Sir,
I don't have word to say thanks to you for helping. I am blessed to meet you in this repository else i would have switched to some other repository. My head is aching constantly from morning.
Thank you.

Some Useless Stuffs:
https://ps-19.github.io/Resume
https://github.com/ps-19
https://github.com/fabric8io/kubernetes-client/pull/3220
https://github.com/CleverRaven/Cataclysm-DDA/pull/51435
https://github.com/fabric8io/kubernetes-client/pull/3279
https://github.com/ersilia-os/ersilia/pull/71
https://codeforces.com/profile/ps-19
https://codeforces.com/profile/naughtyGirl
https://www.codechef.com/users/ps_19
https://www.codechef.com/users/rising_ever
https://www.hackerearth.com/@ps_19
https://www.hackerrank.com/ps_20
https://www.spoj.com/users/priyansh_19

[aaron.ballman]

I have commit on your behalf in 1cb299165c859533e22f2ed05eb2abd5071544df -- I took the liberty of rewording the commit message a bit (FWIW, we usually pull the commit message from the patch review summary, but in this case the review summary didn't quite match what was in the patch and had a lot of extraneous information).

README.md

 # The LLVM Compiler Infrastructure
 
 This directory and its sub-directories contain source code for LLVM,
 a toolkit for the construction of highly optimized compilers,
 optimizers, and run-time environments.
 
 The README briefly describes how to get started with building LLVM.
 For more information on how to contribute to the LLVM project, please
 take a look at the
 [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
 
 ## Getting Started with the LLVM System
 
-Taken from https://llvm.org/docs/GettingStarted.html.
+Taken from [here](https://llvm.org/docs/GettingStarted.html).
 
 ### Overview
 
 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.
 
 Other components include:
 the [libc++ C++ standard library](https://libcxx.llvm.org),
 the [LLD linker](https://lld.llvm.org), and more.
 
 ### Getting the Source Code and Building LLVM
2. Configure and build LLVM and Clang:
 
      * ``cd llvm-project``
 
      * ``cmake -S llvm -B build -G <generator> [options]``
 
         Some common build system generators are:
 
         * ``Ninja`` --- for generating [Ninja](https://ninja-build.org)
           build files. Most llvm developers use Ninja.
         * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
         * ``Visual Studio`` --- for generating Visual Studio projects and
           solutions.
         * ``Xcode`` --- for generating Xcode projects.
 
         Some common options:
 
         * ``-DLLVM_ENABLE_PROJECTS='...'`` and ``-DLLVM_ENABLE_RUNTIMES='...'`` ---
* ``cmake -S llvm -B build -G <generator> [options]``
         * The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.
 
         * The ``check-all`` target (i.e. ``ninja check-all``) will run the
           regression tests to ensure everything is in working order.
 
         * 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)
 page for detailed information on configuring and compiling LLVM. You can visit
 [Directory Layout](https://llvm.org/docs/GettingStarted.html#directory-layout)
 to learn about the layout of the source code tree.
 
 ## Getting in touch
 
 Join [LLVM Discourse forums](https://discourse.llvm.org/), [discord chat](https://discord.gg/xS7Z362) or #llvm IRC channel on [OFTC](https://oftc.net/).
 
 The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for
 participants to all modes of communication within the project.