File Extension

[ps-19]

Summary

Transferred the file from .txt to .md file as .md is now more standard than .txt .

Name: Priyansh Singh
Email: [e-mail]

[beanz]

Overall this seems like a nice change. There is one unrelated change fixing a typo in here that should be removed and posted separately.

llvm/utils/wciia.py

101

This change is unrelated, and should be in a separate patch.

[smeenai]

I'm not really sure about the ".md being more standard than .txt" in the summary, but I guess it's more standard with Github (where Markdown gets nice rendering), so this makes sense.

llvm/README.md

+# The LLVM Compiler Infrastructure
+
+This directory and its subdirectories contain source code for LLVM,
+a toolkit for the construction of highly optimized compilers,
+optimizers, and runtime environments.
+
+LLVM is open source software. You may freely distribute it under the terms of
+the license agreement found in [LICENSE](/LICENSE.TXT).
+
+Please see the documentation provided in [docs](/docs/) for further
+assistance with LLVM, and in particular [Getting Started](/docs/GettingStarted.rst for getting started with LLVM and [README](/docs/README.md) for an overview of LLVM's documentation setup.
+
+If you are writing a package for LLVM, see [Packaging](/docs/Packaging.rst) for our
+suggestions.

llvm/README.txt

-The LLVM Compiler Infrastructure
-================================
-
-This directory and its subdirectories contain source code for LLVM,
-a toolkit for the construction of highly optimized compilers,
-optimizers, and runtime environments.
-
-LLVM is open source software. You may freely distribute it under the terms of
-the license agreement found in LICENSE.txt.
-
-Please see the documentation provided in docs/ for further
-assistance with LLVM, and in particular docs/GettingStarted.rst for getting
-started with LLVM and docs/README.txt for an overview of LLVM's
-documentation setup.
-
-If you are writing a package for LLVM, see docs/Packaging.rst for our
-suggestions.

llvm/docs/README.md

-LLVM Documentation
-==================
-
-LLVM's documentation is written in reStructuredText, a lightweight
-plaintext markup language (file extension `.rst`). While the
-reStructuredText documentation should be quite readable in source form, it
-is mostly meant to be processed by the Sphinx documentation generation
-system to create HTML pages which are hosted on <https://llvm.org/docs/> and
-updated after every commit. Manpage output is also supported, see below.
-
-If you instead would like to generate and view the HTML locally, install
-Sphinx <http://sphinx-doc.org/> and then do:
-
-    cd <build-dir>
-    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
-    make -j3 docs-llvm-html
-    $BROWSER <build-dir>/docs/html/index.html
-
-The mapping between reStructuredText files and generated documentation is
-`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.
-
-If you are interested in writing new documentation, you will want to read
-`SphinxQuickstartTemplate.rst` which will get you writing documentation
-very fast and includes examples of the most important reStructuredText
-markup syntax.
-
-Manpage Output
-===============
-
-Building the manpages is similar to building the HTML documentation. The
-primary difference is to use the `man` makefile target, instead of the
-default (which is `html`). Sphinx then produces the man pages in the
-directory `<build-dir>/docs/man/`.
-
-    cd <build-dir>
-    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
-    make -j3 docs-llvm-man
-    man -l <build-dir>/docs/man/FileCheck.1
-
-The correspondence between .rst files and man pages is
-`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
-These .rst files are also included during HTML generation so they are also
-viewable online (as noted above) at e.g.
-`https://llvm.org/docs/CommandGuide/Foo.html`.
-
-Checking links
-==============
-
-The reachability of external links in the documentation can be checked by
-running:
-
-    cd llvm/docs/
-    sphinx-build -b linkcheck . _build/lintcheck/
-    # report will be generated in _build/lintcheck/output.txt
-
-Doxygen page Output
-==============
-
-Install doxygen <https://www.doxygen.nl/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.
-
-    cd <build-dir>
-    cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
-    make doxygen-llvm # for LLVM docs
-    make doxygen-clang # for clang docs
-
-It will generate html in
-
-    <build-dir>/docs/doxygen/html # for LLVM docs
-    <build-dir>/tools/clang/docs/doxygen/html # for clang docs
+# LLVM Documentation
+
+LLVM's documentation is written in `reStructuredText`, a lightweight
+plaintext markup language (file extension `.rst`). While the
+`reStructuredText` documentation should be quite readable in source form, it
+is mostly meant to be processed by the Sphinx documentation generation
+system to create HTML pages which are hosted [here](https://llvm.org/docs/) and
+updated after every commit. Manpage output is also supported, see below.
+
+If you instead would like to generate and view the HTML locally, install
+[Sphinx](http://sphinx-doc.org/) and then do:
+
+    cd <build-dir>
+    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
+    make -j3 docs-llvm-html
+    $BROWSER <build-dir>/docs/html/index.html
+
+The mapping between `reStructuredText` files and generated documentation is: <br/>
+
+`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`.
+
+If you are interested in writing new documentation, you will need to read
+`SphinxQuickstartTemplate.rst` which will get you writing documentation
+very fast and includes examples of the most important `reStructuredText`
+markup syntax.
+
+# Manpage Output
+
+Building the manpages is similar to building the HTML documentation. The
+primary difference is to use the `man` makefile target, instead of the
+default (which is `html`). Sphinx then produces the man pages in the
+directory `<build-dir>/docs/man/`.
+
+```
+    cd <build-dir>
+    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
+    make -j3 docs-llvm-man
+    man -l <build-dir>/docs/man/FileCheck.1
+```
+
+The correspondence between .rst files and man pages is: <br/>
+`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
+
+These `.rst` files are also included during HTML generation so they are also
+viewable online at e.g.
+
+`https://llvm.org/docs/CommandGuide/Foo.html`.
+
+# Checking links
+
+The reachability of external links in the documentation can be checked by
+running:
+```
+    cd llvm/docs/
+    sphinx-build -b linkcheck . _build/lintcheck/
+    # report will be generated in _build/lintcheck/output.txt
+```
+# Doxygen page output
+
+Install [doxygen](https://www.doxygen.nl/download.html) and [dot2tex](https://dot2tex.readthedocs.io/en/latest).
+
+```
+    cd <build-dir>
+    cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
+    make doxygen-llvm # for LLVM docs
+    make doxygen-clang # for clang docs
+```
+
+It will generate html in: <br/>
+<br/>
+**1. For LLVM Docs**
+- <build-dir>/docs/doxygen/html
+
+**2. For Clang Docs**
+- <build-dir>/tools/clang/docs/doxygen/html

llvm/utils/wciia.py

for name in code_owners:
                     if len(fpath) < len(path):
                         rpos = path.find(fpath)
                     if rpos == 0:
                         onames.append(name)
     onames.append('Chris Lattner')
     return onames
 
 
-# now lest try to find the owner of the file or folder
+# now let's try to find the owner of the file or folder
 import sys
 
 if len(sys.argv) < 2:
     print("usage " + sys.argv[0] + " file_or_folder")
     exit(-1)
 
 # the path we are checking
 path = str(sys.argv[1])