[flang-commits] [flang] ea5ce2f - [flang][nfc] Update README.md

Andrzej Warzynski via flang-commits flang-commits at lists.llvm.org
Thu Jan 13 02:32:53 PST 2022


Author: Andrzej Warzynski
Date: 2022-01-13T10:28:41Z
New Revision: ea5ce2fc55b7d06c29cdf43e0f748f829c32b76e

URL: https://github.com/llvm/llvm-project/commit/ea5ce2fc55b7d06c29cdf43e0f748f829c32b76e
DIFF: https://github.com/llvm/llvm-project/commit/ea5ce2fc55b7d06c29cdf43e0f748f829c32b76e.diff

LOG: [flang][nfc] Update README.md

With https://reviews.llvm.org/D116731 merged, installing Clang, MLIR or
LLVM is no longer required for standalone builds. For consistency sake,
remove "installation" from the build instrucitons.

Differential Revision: https://reviews.llvm.org/D117100

Added: 
    

Modified: 
    flang/README.md

Removed: 
    


################################################################################
diff  --git a/flang/README.md b/flang/README.md
index bf6517f759f27..a8cd9c83846df 100644
--- a/flang/README.md
+++ b/flang/README.md
@@ -37,14 +37,13 @@ If you are interested in writing new documentation, follow
 [markdown style guide from LLVM](https://github.com/llvm/llvm-project/blob/main/llvm/docs/MarkdownQuickstartTemplate.md).
 
 ## Building flang
-There are two ways to build flang.  The first method is to build it at the same
-time that you build all of the projects on which it depends.  This is called
-building in tree.  The second method is to first do an in tree build to create
-all of the projects on which flang depends, then build an install area for
-these projects, and then only build the flang code itself.  This is called
-building standalone.  Building standalone has the advantage of being smaller
-and faster.  Once you create the base build and base install areas, you can
-create multiple standalone builds using them.  
+There are two ways to build flang. The first method is to build it at the same
+time that you build all of the projects on which it depends. This is called
+building in tree. The second method is to first do an in tree build to create
+all of the projects on which flang depends, and then only build the flang code
+itself. This is called building standalone. Building standalone has the
+advantage of being smaller and faster. Once you create the base build and base
+install areas, you can create multiple standalone builds using them.
 
 Note that instructions for building LLVM can be found at
 https://llvm.org/docs/GettingStarted.html.
@@ -65,10 +64,8 @@ git clone https://github.com/llvm/llvm-project.git my-project
 Once the clone is complete, execute the following commands:
 ```bash
 cd my-project
-INSTALLDIR=`pwd`/install
 
 rm -rf build
-rm -rf install
 mkdir -p build
 
 cd build
@@ -93,12 +90,6 @@ directory:
 ninja check-flang
 ```
 
-If you're happy with the results, the next step is to create the install area.
-While in the `build` directory, run the command:
-```bash
-ninja install
-```
-
 Note that these instructions specify flang as one of the projects to build in
 the in tree build.  This is not strictly necessary for subsequent standalone
 builds, but doing so lets you run the flang tests to verify that the source
@@ -129,18 +120,12 @@ cmake \
   -DLLVM_BUILD_MAIN_SRC_DIR=$base/build/lib/cmake/llvm \
   -DLLVM_LIT_ARGS=-v \
   -DLLVM_DIR=$base/build/lib/cmake/llvm \
-  -DCLANG_DIR=$base/install/lib/cmake/clang \
-  -DMLIR_DIR=$base/install/lib/cmake/mlir \
+  -DCLANG_DIR=$base/build/lib/cmake/clang \
+  -DMLIR_DIR=$base/build/lib/cmake/mlir \
   ..
 
 ninja
 ```
-Note that for Clang and MLIR you use the installation directory ($base/install)
-and for LLVM you use the build directory (`$base/build`).   This is not a typo
-in the script.  Rather, it is because running the tests requires the GTest
-infrastructure which is only available in the LLVM build area.  The build also
-requires the `AddClang.cmake` script from Clang, which is only available in the
-install area.
 
 To run the flang tests on this build, execute the command in the "flang/build"
 directory:


        


More information about the flang-commits mailing list