[llvm] r350632 - [gn build] Update readme

Nico Weber via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 8 07:19:00 PST 2019


Author: nico
Date: Tue Jan  8 07:19:00 2019
New Revision: 350632

URL: http://llvm.org/viewvc/llvm-project?rev=350632&view=rev
Log:
[gn build] Update readme

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

Modified:
    llvm/trunk/utils/gn/README.rst

Modified: llvm/trunk/utils/gn/README.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/utils/gn/README.rst?rev=350632&r1=350631&r2=350632&view=diff
==============================================================================
--- llvm/trunk/utils/gn/README.rst (original)
+++ llvm/trunk/utils/gn/README.rst Tue Jan  8 07:19:00 2019
@@ -18,11 +18,7 @@ to update GN build files. Reviewers shou
 files. Keeping the GN build files up-to-date is on the people who use the GN
 build.
 
-*Another Warning* Right now, we're in the process of getting the GN build
-checked in. As of this writing, it's not yet functional at all. Check back
-in a few weeks!
-
-`GN <https://gn.googlesource.com/gn/>`_ is another metabuild system. It always
+`GN <https://gn.googlesource.com/gn/>`_ is a metabuild system. It always
 creates ninja files, but it can create some IDE projects (MSVC, Xcode, ...)
 which then shell out to ninja for the actual build.
 
@@ -32,11 +28,6 @@ a 2000x difference), and since it's so f
 making it possible to switch e.g. between release and debug builds in one build
 directory.
 
-It is arguable easier to configure than the CMake build, and has native support
-for building with multiple toolchains in one build directory. The build
-description is declarative-ish, allowing GN to print it in a json format that
-can fairly easily be converted to other metabuild system inputs.
-
 The main motivation behind the GN build is that some people find it more
 convenient for day-to-day hacking on LLVM than CMake. Distribution, building
 just parts of LLVM, and embedding the LLVM GN build from other builds are a
@@ -49,9 +40,6 @@ This is a `good overview of GN <https://
 Quick start
 ===========
 
-*Warning* Right now, we're in the process of getting the GN build checked in.
-As of this writing, it's not yet functional at all.
-
 GN only works in the monorepo layout.
 
 #. Obtain a `gn binary <https://gn.googlesource.com/gn/#getting-started>`_.
@@ -61,8 +49,8 @@ GN only works in the monorepo layout.
    build directory, it can have any name, and you can have as many as you want,
    each with different build settings).
 
-#. Run e.g. `ninja -C out/gn llvm-undname` to build all prerequisites for and
-   including the Microsoft symbol name pretty printing tool llvm-undname.
+#. Run e.g. `ninja -C out/gn check-lld` to build all prerequisites for and
+   run the LLD tests.
 
 By default, you get a release build with assertions enabled that targets
 the host arch. You can set various build options by editing `out/gn/args.gn`,




More information about the llvm-commits mailing list