[docs] Update Getting Started with Visual Studio guide

[yaron.keren]

Summary

Update this document for 2021.

[yaron.keren]

add all commits

[yaron.keren]

Fix typo

[yaron.keren]

Trying to fix the diff

[yaron.keren]

Trying yet again to fix the diff

[kuhnel]

Thx for cleaning up the Windows instructions!

I only have a view minor remarks (see inline comments).

As a side note:
I'm also working on a tutorial for Visual Studio Code on Windows, however I didn't really have time to finish that yet.
What's missing so far: Debugging with LLDB, installing the Visual Studio compiler (without UI) and use these.

llvm/docs/GettingStartedVS.rst

48–50

Nit: Maybe add a comment that the "Community Edition" is enough.

113

Nit: Maybe call out, that you're only building clang here and users need to configure the other projects as needed, e.g. as explained in https://llvm.org/docs/CMake.html#frequently-used-llvm-related-variables

118–123

I'm not familiar with using CMake with the Visual Studio build system, but don't you need to set the output build system with cmake -G "Visual Studio 17 2022? Or is that set automatically?

145–146

I guess we should also update these instructions, based on your new tool recommendations.

150

Why not Release with Debug info? This gives you much more information when debugging problems?

[aaron.ballman]

llvm/docs/GettingStartedVS.rst

42

If we're going to recommend hardware, should we also recommend a significant amount of RAM?

55

I'm a bit worried about losing this information; I didn't have luck skipping GnuWin32 the last time I tried (about a year ago), so I don't think just Python is sufficient. WDYT?

59

113

Before getting to "finally", should we explain what needs installation for tests to work (like GnuWin32)?

182–183

Not certain why we need to churn these examples (FWIW, capital drive letters are still quite common).

[amccarth]

I also thank you for working to improve this documentation. I mostly agree the other reviewer. I've only added a couple inline comments to raise questions. I wouldn't hold this back for either of those.

llvm/docs/GettingStartedVS.rst

55

The git-provided versions of common unix tools have been sufficient for me (except there's no make in git). The git ones are also newer than the GnuWin32 ones, and a couple of them behave slightly differently.

The only reason I still I install GnuWin32 is because lldb tests require make. That said, I make sure that GnuWin32 comes _after_ git in my PATH. Otherwise, other things go wrong. GnuWin32 is old and unmaintained. I don't think we can expect Windows developers to continue to rely on it.

I'm not against mentioning it as a possibility, but I don't think it belongs in the mainline "Getting Started" recommendations.

118–123

That's an interesting question. I've never actually built from the Visual Studio IDE. I use CMake to generate solution and project files for browsing, editing, and debugging. But I also have CMake generate a ninja solution and actually build from the command line. In both cases, I explicitly specify the generator. If we're not recommending ninja for builds, then maybe we don't need to mention how to install it.

[mstorsjo]

llvm/docs/GettingStartedVS.rst

55

Also FYI, regarding GnuWin32 vs the git unix tools - the llvm lit tests also have a provision where they try to locate the git unix tools and add them to the path, but this isn't hooked up when running other testsuites (like for libcxx). See https://github.com/llvm/llvm-project/blob/main/llvm/utils/lit/lit/llvm/config.py#L29-L35.

[aaron.ballman]

llvm/docs/GettingStartedVS.rst

55

If the git tools are sufficient, that's fantastic news (I've been hoping we can get rid of this insecure and long-unsupported requirement for years)! When I last tried, they weren't sufficient; I recall some Clang lit tests were failing because of missing utilities like sed. But if you think they're now sufficient, perhaps we should document that more clearly as a need for the testing system? (Also, perhaps the issue is that Git for Windows that comes with VS 2019 may be different from what you download manually, and if so, that would be useful to tell people if it actually matters to the testing system.)

[mstorsjo]

llvm/docs/GettingStartedVS.rst

55

At least the pre-merge test bot runs without GnuWin32 now, but it manually adds the c:\Program Files\Git\usr\bin directory to the path instead. The llvm lit config that I linked does look for a path to something similar via the registry, I guess that doesn't find git bundled with Visual Studio (and I'm not sure if that bundled the same unix utilities in the same way).

[yaron.keren]

llvm/docs/GettingStartedVS.rst

42

OK

48–50

ok

55

The Visual Studio installer installs a slightly older git (2.31.1) than the standalone installer from the web site (2.33). Otherwise identical and (unlike cmake) installed into the same install location (c:\Program Files\Git\).

The bash utilities installed in c:\Program Files\Git\usr\bin\ (from either version of Git for Windows) pass regression tests for llvm & clang pass. Nothing besides the documented here is required.

llvm-lit config.py indeed can find Git for Windows utilities even if not on the PATH by looking in the registry. This is a very nice "just works" functionality to share with other llvm projects.

I had not tested projects of LLVM other than llvm and clang - this is the scope of a "Getting Started" page ?

59

Thanks for catching this!

113

GnuWin32 functionality is replaced by the bash tools in Git for Windows (in c:\Program Files\Git\usr\bin\)

113

Clarified at the page that the scope is llvm&clang only, to keep this simple. Refered to the CMake page.

118–123

On Windows cmake defaults to the latest Visual Studio (and on Linux to Unix Makefiles).

145–146

OK

150

On my system Release build is 1.8GB whereas RelWithDebInfo build is 16GB. Will explain this.

182–183

Yes indeed this page should be Visual Studio specific - removed!

[yaron.keren]

Address comments

[aaron.ballman]

LGTM, thank you for the improved documentation! (Please wait a bit before landing in case other active reviewers to chime in with further feedback.)

llvm/docs/GettingStartedVS.rst

55

I had not tested projects of LLVM other than llvm and clang - this is the scope of a "Getting Started" page ?

I'd say it's not, but if others want to build a case for why it is, I could be persuaded. Personally, I think the docs are good as-is now.

[sylvestre.ledru]

Sorry, I don't know enough about Visual Studio to be a proper reviewer :)

[amccarth]

LGTM.

llvm/docs/GettingStartedVS.rst

55

The Visual Studio installer installs a slightly older git (2.31.1) than the standalone installer from the web site (2.33).

True. But the good news is that git will prompt you to update within a day or so.

I recall some Clang lit tests were failing because of missing utilities like sed.

$ where sed
C:\Program Files\Git\usr\bin\sed.exe

The only missing utility that I'm aware of is make, which is necessary for lldb's tests.

I generally agree that projects other than llvm and clang are out of scope for this page. It would be nice, however, if additional projects were strictly additive. That is, if you've gone through these steps and now you also want to build llvm-xyzzy, having to install a couple more dependents is fine. But if you'd have to undo part of your setup and do something else instead, that would be (and has been) annoying. Right now, I think we're in a good state.

[yaron.keren]

Upload lal local commits to include all local changes

[yaron.keren]

Thanks for all the comments!

[aeubanks]

continuing from D119074, there are still a bunch of references to gnuwin around the codebase, those should be cleaned up

git bash is great for development, but it's kind of hard to automatically download and install on bots. our LLVM bots have git available via Chrome tools (specifically depot_tools)

[mstorsjo]

In D108513#3326903, @aeubanks wrote:

git bash is great for development, but it's kind of hard to automatically download and install on bots. our LLVM bots have git available via Chrome tools (specifically depot_tools)

The premerge buildbots install it in their Docker image with Chocolatey, with a single command choco install -y git, see https://github.com/google/llvm-premerge-checks/blob/main/containers/agent-windows-vs2019/Dockerfile#L41-L43.

[kuhnel]

We're actually using chocolatey for all tools that it offers in pre-merge and that works very well, much better than downloading installers and executing them...

Visual Studio was quite tricky to automate and required lots of trial-and-error. But bot owners can copy and past from the docker image if they want to. We could also share a Visual Studio base image if anyone cares...

[aeubanks]

In D108513#3328480, @kuhnel wrote:

We're actually using chocolatey for all tools that it offers in pre-merge and that works very well, much better than downloading installers and executing them...

Which package are you using to get gnu tools?

Visual Studio was quite tricky to automate and required lots of trial-and-error. But bot owners can copy and past from the docker image if they want to. We could also share a Visual Studio base image if anyone cares...

I mostly work with the Chrome LLVM bots, and Chrome has its own installation of Visual Studio on its Windows bots so that's not a problem for us.

[mstorsjo]

In D108513#3330373, @aeubanks wrote:

In D108513#3328480, @kuhnel wrote:

We're actually using chocolatey for all tools that it offers in pre-merge and that works very well, much better than downloading installers and executing them...

Which package are you using to get gnu tools?

Git for Windows comes with its own installation of a bunch of them, and llvm's lit does pick them up automatically if they aren't available in PATH: https://github.com/llvm/llvm-project/blob/main/llvm/utils/lit/lit/llvm/config.py#L31-L35

[yaron.keren]

Git for Windows comes with its own installation of a bunch of them, and llvm's lit does pick them up automatically if they aren't available in PATH: https://github.com/llvm/llvm-project/blob/main/llvm/utils/lit/lit/llvm/config.py#L31-L35

It's easy to have Git for Windows installed by the Visual Studio installer itself : in Workloads tab, select the Desktop development with C++ workload. Under Individual components tab, select Git for Windows.

[kuhnel]

In D108513#3330373, @aeubanks wrote:

In D108513#3328480, @kuhnel wrote:

We're actually using chocolatey for all tools that it offers in pre-merge and that works very well, much better than downloading installers and executing them...

Which package are you using to get gnu tools?

Oh, looks like @goncharov has changed from GnuWin to git almost a year ago. In the past we were using this package.

You can find the details on the tool installation in the Windows Dockerfile.

llvm/docs/GettingStartedVS.rst

 ==================================================================
 Getting Started with the LLVM System using Microsoft Visual Studio
 ==================================================================
 
+
 .. contents::
    :local:
 
 
 Overview
 ========
 Welcome to LLVM on Windows! This document only covers LLVM on Windows using
-Visual Studio, not mingw or cygwin. In order to get started, you first need to
-know some basic information.
+Visual Studio, not WSL, mingw or cygwin. In order to get started, you first need
+to know some basic information.
 
 There are many different projects that compose LLVM. The first piece is the
 LLVM suite. This contains all of the tools, libraries, and header files needed
 to use LLVM. It contains an assembler, disassembler, bitcode analyzer and
 bitcode optimizer. It also contains basic regression tests that can be used to
 test the LLVM tools and the Clang front end.
 
 The second piece is the `Clang <https://clang.llvm.org/>`_ front end.  This
 component compiles C, C++, Objective C, and Objective C++ code into LLVM
 bitcode. Clang typically uses LLVM libraries to optimize the bitcode and emit
 machine code. LLVM fully supports the COFF object file format, which is
 compatible with all other existing Windows toolchains.
 
-The last major part of LLVM, the execution Test Suite, does not run on Windows,
-and this document does not discuss it.
-
-Additional information about the LLVM directory structure and tool chain
-can be found on the main :doc:`GettingStarted` page.
+There are more LLVM projects which this document does not discuss.
 
 
 Requirements
 ============
 Before you begin to use the LLVM system, review the requirements given
 below.  This may save you some trouble by knowing ahead of time what hardware
 and software you will need.
 
 Hardware
 --------
 Any system that can adequately run Visual Studio 2017 is fine. The LLVM
-source tree and object files, libraries and executables will consume
-approximately 3GB.
+source tree including the git index consumes approximately 3GB.
+Object files, libraries and executables consume approximately 5GB in
+Release mode and much more in Debug mode. SSD drive and >16GB RAM are
+recommended.
+
 
 Software
 --------
-You will need Visual Studio 2017 or higher, with the latest Update installed.
+You will need `Visual Studio <https://visualstudio.microsoft.com/>`_ 2017 or
+higher, with the latest Update installed. Visual Studio Community Edition
+suffices.
 
 You will also need the `CMake <http://www.cmake.org/>`_ build system since it
-generates the project files you will use to build with.
+generates the project files you will use to build with. CMake is bundled with
+Visual Studio 2019 so seperate installation is not required.
 
 If you would like to run the LLVM tests you will need `Python
-<http://www.python.org/>`_. Version 3.6 and newer are known to work. You will
-need `GnuWin32 <http://gnuwin32.sourceforge.net/>`_ tools, too.
+<http://www.python.org/>`_. Version 3.6 and newer are known to work. You can
+install Python with Visual Studio 2019, from the Microsoft store or from
+the `Python web site <http://www.python.org/>`_. We recommend the latter since it
+allows you to to adjust installation options.
 
-Do not install the LLVM directory tree into a path containing spaces (e.g.
-``C:\Documents and Settings\...``) as the configure step will fail.
+You will need `Git for Windows <https://git-scm.com/>`_ with bash tools, too.
+Git for Windows is also bundled with Visual Studio 2019.
 
-To simplify the installation procedure, you can also use 
-`Chocolatey <https://chocolatey.org/>`_ as package manager. After the
-`installation <https://chocolatey.org/install>`_ of Chocolatey, run these
-commands in an admin shell to install the required tools:
+
+Getting Started
+===============
+Here's the short story for getting up and running quickly with LLVM.
+These instruction were tested with Visual Studio 2019 and Python 3.9.6:
+
+1. Download and install `Visual Studio <https://visualstudio.microsoft.com/>`_.
+2. In the Visual Studio installer, Workloads tab, select the
+   **Desktop development with C++** workload. Under Individual components tab,
+   select **Git for Windows**.
+3. Complete the Visual Studio installation.
+4. Download and install the latest `Python 3 release <http://www.python.org/>`_.
+5. In the first install screen, select both **Install launcher for all users**
+   and **Add Python to the PATH**. This will allow installing psutil for all
+   users for the regression tests and make Python available from the command
+   line.
+6. In the second install screen, select (again) **Install for all users** and
+   if you want to develop `lldb <https://lldb.llvm.org/>`_, selecting
+   **Download debug binaries** is useful.
+7. Complete the Python installation.
+8. Run a "Developer Command Prompt for VS 2019" as administrator. This command
+    prompt provides correct path and environment variables to Visual Studio and
+    the installed tools.
+9. In the terminal window, type the commands:
 
    .. code-block:: bat
 
-   choco install -y ninja git cmake gnuwin python3
-   pip3 install psutil
+     c:
+     cd \
 
-There is also a Windows 
-`Dockerfile <https://github.com/llvm/llvm-zorg/blob/main/buildbot/google/docker/windows-base-vscode2019/Dockerfile>`_ 
-with the entire build tool chain. This can be used to test the build with a
-tool chain different from your host installation or to create build servers. 
+  You may install the llvm sources in other location than ``c:\llvm`` but do not
+  install into a path containing spaces (e.g. ``c:\Documents and Settings\...``)
+  as it will fail.
 
-Getting Started
-===============
-Here's the short story for getting up and running quickly with LLVM:
+10. Install psutil and obtain LLVM source code:
 
-1. Read the documentation.
-2. Seriously, read the documentation.
-3. Remember that you were warned twice about reading the documentation.
-4. Get the Source Code
+    .. code-block:: bat
 
-   * With the distributed files:
+     pip install psutil
+     git clone https://github.com/llvm/llvm-project.git llvm
  
-      1. ``cd <where-you-want-llvm-to-live>``
-      2. ``gunzip --stdout llvm-VERSION.tar.gz | tar -xvf -``
-         (*or use WinZip*)
-      3. ``cd llvm``
+ Instead of ``git clone`` you may download a compressed source distribution
+ from the `releases page <https://github.com/llvm/llvm-project/releases>`_.
+ Select the last link: ``Source code (zip)`` and unpack the downloaded file using
+ Windows Explorer built-in zip support or any other unzip tool.
 
-   * With git access:
+11. Finally, configure LLVM using CMake:
 
-     *Note:* some regression tests require Unix-style line ending (``\n``).
+    .. code-block:: bat
+
+       cmake -S llvm\llvm -B build -DLLVM_ENABLE_PROJECTS=clang -DLLVM_TARGETS_TO_BUILD=X86 -Thost=x64
+       exit
 
-      1. ``cd <where-you-want-llvm-to-live>``
-      2. ``git clone https://github.com/llvm/llvm-project.git llvm``
-      3. ``cd llvm``
+   ``LLVM_ENABLE_PROJECTS`` specifies any additional LLVM projects you want to
+   build while ``LLVM_TARGETS_TO_BUILD`` selects the compiler targets. If
+   ``LLVM_TARGETS_TO_BUILD`` is omitted by default all targets are built
+   slowing compilation and using more disk space.
+   See the :doc:`LLVM CMake guide <CMake>` for detailed information about
+   how to configure the LLVM build.
 
-5. Use `CMake <http://www.cmake.org/>`_ to generate up-to-date project files:
+   The ``cmake`` command line tool is bundled with Visual Studio but its GUI is
+   not. You may install `CMake <http://www.cmake.org/>`_ to use its GUI to change
+   CMake variables or modify the above command line.
 
    * Once CMake is installed then the simplest way is to just start the
      CMake GUI, select the directory where you have LLVM extracted to, and
      the default options should all be fine.  One option you may really
      want to change, regardless of anything else, might be the
      ``CMAKE_INSTALL_PREFIX`` setting to select a directory to INSTALL to
      once compiling is complete, although installation is not mandatory for
      using LLVM.  Another important option is ``LLVM_TARGETS_TO_BUILD``,
      which controls the LLVM target architectures that are included on the
      build.
-   * If CMake complains that it cannot find the compiler, make sure that
-     you have the Visual Studio C++ Tools installed, not just Visual Studio
-     itself (trying to create a C++ project in Visual Studio will generally
-     download the C++ tools if they haven't already been).
-   * Run cmake from a "x86/x64 Native Tools Command Prompt" so Visual C++ will
-     be on the PATH and its environment variables are set. Do **not** use
-     ``CMAKE_C_COMPILER`` and ``CMAKE_CXX_COMPILER`` for this purpose:
-
-     .. code-block:: bat
-
-        **********************************************************************
-        ** Visual Studio 2019 Developer Command Prompt v16.11.1
-        ** Copyright (c) 2021 Microsoft Corporation
-        **********************************************************************
-        [vcvarsall.bat] Environment initialized for: 'x64'
-        c:\build> cmake ..\llvm\llvm -DLLVM_ENABLE_PROJECTS=clang -DLLVM_TARGETS_TO_BUILD=X86 -Thost=x64
-
-   * See the :doc:`LLVM CMake guide <CMake>` for detailed information about
-     how to configure the LLVM build.
    * CMake generates project files for all build types. To select a specific
      build type, use the Configuration manager from the VS IDE or the
      ``/property:Configuration`` command line option when using MSBuild.
    * By default, the Visual Studio project files generated by CMake use the
      32-bit toolset. If you are developing on a 64-bit version of Windows and
      want to use the 64-bit toolset, pass the ``-Thost=x64`` flag when
      generating the Visual Studio solution. This requires CMake 3.8.0 or later.
 
-6. Start Visual Studio
-
-   * In the directory you created the project files will have an ``llvm.sln``
-     file, just double-click on that to open Visual Studio.
+12. Start Visual Studio and select configuration:
 
-7. Build the LLVM Suite:
+   In the directory you created the project files will have an ``llvm.sln``
+   file, just double-click on that to open Visual Studio. The default Visual
+   Studio configuration is **Debug** which is slow and generates a huge amount
+   of debug information on disk. For now, we recommend selecting **Release**
+   configuration for the LLVM project which will build the fastest or
+   **RelWithDebInfo** which is also several time larger than Release.
+   Another technique is to build all of LLVM in Release mode and change
+   compiler flags, disabling optimization and enabling debug information, only
+   for specific librares or source files you actually need to debug.
+
+13. Test LLVM in Visual Studio:
+
+   You can run LLVM tests by merely building the project "check-all". The test
+   results will be shown in the VS output window. Once the build succeeds, you
+   have verified a working LLVM development environment!
+   
+   You should not see any unexpected failures, but will see many unsupported
+   tests and expected failures:
+
+   ::
+
+    114>Testing Time: 1124.66s
+    114>  Skipped          :    39
+    114>  Unsupported      : 21649
+    114>  Passed           : 51615
+    114>  Expectedly Failed:    93
+    ========== Build: 114 succeeded, 0 failed, 321 up-to-date, 0 skipped ==========``
+
+Alternatives to manual installation
+===================================
+Instead of the steps above, to simplify the installation procedure you can use
+`Chocolatey <https://chocolatey.org/>`_ as package manager.
+After the `installation <https://chocolatey.org/install>`_ of Chocolatey,
+run these commands in an admin shell to install the required tools:
 
-   * The projects may still be built individually, but to build them all do
-     not just select all of them in batch build (as some are meant as
-     configuration projects), but rather select and build just the
-     ``ALL_BUILD`` project to build everything, or the ``INSTALL`` project,
-     which first builds the ``ALL_BUILD`` project, then installs the LLVM
-     headers, libs, and other useful things to the directory set by the
-     ``CMAKE_INSTALL_PREFIX`` setting when you first configured CMake.
-   * The Fibonacci project is a sample program that uses the JIT. Modify the
-     project's debugging properties to provide a numeric command line argument
-     or run it from the command line.  The program will print the
-     corresponding fibonacci value.
+.. code-block:: bat
 
-8. Test LLVM in Visual Studio:
+   choco install -y git cmake python3
+   pip3 install psutil
 
-   * If ``%PATH%`` does not contain GnuWin32, you may specify
-     ``LLVM_LIT_TOOLS_DIR`` on CMake for the path to GnuWin32.
-   * You can run LLVM tests by merely building the project "check-all". The test
-     results will be shown in the VS output window.
+There is also a Windows 
+`Dockerfile <https://github.com/llvm/llvm-zorg/blob/main/buildbot/google/docker/windows-base-vscode2019/Dockerfile>`_ 
+with the entire build tool chain. This can be used to test the build with a
+tool chain different from your host installation or to create build servers. 
 
-9. Test LLVM on the command line:
+Next steps
+==========
+1. Read the documentation.
+2. Seriously, read the documentation.
+3. Remember that you were warned twice about reading the documentation.
 
-   * The LLVM tests can be run by changing directory to the llvm source
-     directory and running:
+Test LLVM on the command line:
+------------------------------
+The LLVM tests can be run by changing directory to the llvm source
 
-     .. code-block:: bat
 
-        c:\llvm> python ..\build\Release\bin\llvm-lit.py llvm\test
 
-     This example assumes that Python is in your PATH variable, you
-     have built a Release version of llvm with a standard out of
-     line build. You should not see any unexpected failures, but will
-     see many unsupported tests and expected failures.
+This example assumes that Python is in your PATH variable, which would be
+after **Add Python to the PATH** was selected during Python installation.
+If you had opened a command window prior to Python installation, you would
+have to close and reopen it to get the updated PATH.
 
-     A specific test or test directory can be run with:
 
-     .. code-block:: bat
 
-        c:\llvm> python ..\build\Release\bin\llvm-lit.py llvm\test\Transforms\Util
 
-
-An Example Using the LLVM Tool Chain
-====================================
-
-1. First, create a simple C file, name it '``hello.c``':
-
-   .. code-block:: c
-
-      #include <stdio.h>
-      int main() {
-        printf("hello world\n");
-        return 0;
-      }
-
-2. Next, compile the C file into an LLVM bitcode file:
-
-   .. code-block:: bat
-
-      C:\..> clang -c hello.c -emit-llvm -o hello.bc
-
-   This will create the result file ``hello.bc`` which is the LLVM bitcode
-   that corresponds the compiled program and the library facilities that
-   it required.  You can execute this file directly using ``lli`` tool,
-   compile it to native assembly with the ``llc``, optimize or analyze it
-   further with the ``opt`` tool, etc.
-
-   Alternatively you can directly output an executable with clang with:
-
-   .. code-block:: bat
-
-      C:\..> clang hello.c -o hello.exe
-
-   The ``-o hello.exe`` is required because clang currently outputs ``a.out``
-   when neither ``-o`` nor ``-c`` are given.
-
-3. Run the program using the just-in-time compiler:
-
-   .. code-block:: bat
-
-      C:\..> lli hello.bc
-
-4. Use the ``llvm-dis`` utility to take a look at the LLVM assembly code:
-
-   .. code-block:: bat
-
-      C:\..> llvm-dis < hello.bc | more
-
-5. Compile the program to object code using the LLC code generator:
-
-   .. code-block:: bat
-
-      C:\..> llc -filetype=obj hello.bc
-
-6. Link to binary using Microsoft link:
-
-   .. code-block:: bat
-
-      C:\..> link hello.obj -defaultlib:libcmt
-
-7. Execute the native code program:
-
-   .. code-block:: bat
-
-      C:\..> hello.exe
-
-
-Common Problems
-===============
-If you are having problems building or using LLVM, or if you have any other
-general questions about LLVM, please consult the :doc:`Frequently Asked Questions
-<FAQ>` page.
+Build the LLVM Suite:
+---------------------
+* The projects may still be built individually, but to build them all do
+  not just select all of them in batch build (as some are meant as
+  configuration projects), but rather select and build just the
+  ``ALL_BUILD`` project to build everything, or the ``INSTALL`` project,
+  which first builds the ``ALL_BUILD`` project, then installs the LLVM
+  headers, libs, and other useful things to the directory set by the
+  ``CMAKE_INSTALL_PREFIX`` setting when you first configured CMake.
+* The Fibonacci project is a sample program that uses the JIT. Modify the
+  project's debugging properties to provide a numeric command line argument
+  or run it from the command line.  The program will print the
+  corresponding fibonacci value.
 
 
 Links
 =====
 This document is just an **introduction** to how to use LLVM to do some simple
 things... there are many more interesting and complicated things that you can
 do that aren't documented here (but we'll gladly accept a patch if you want to
 write something up!).  For more information about LLVM, check out:
 
 * `LLVM homepage <https://llvm.org/>`_
 * `LLVM doxygen tree <https://llvm.org/doxygen/>`_
-
+* Additional information about the LLVM directory structure and tool chain
+  can be found on the main :doc:`GettingStarted` page.
+* If you are having problems building or using LLVM, or if you have any other
+  general questions about LLVM, please consult the
+  :doc:`Frequently Asked Questions <FAQ>` page.