Skip to content

Commit 59e373f

Browse files
committed
[gn build] Update readme
Differential Revision: https://reviews.llvm.org/D56375 llvm-svn: 350632
1 parent 7bb9ed1 commit 59e373f

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

llvm/utils/gn/README.rst

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,7 @@ to update GN build files. Reviewers should not ask authors to update GN build
1818
files. Keeping the GN build files up-to-date is on the people who use the GN
1919
build.
2020

21-
*Another Warning* Right now, we're in the process of getting the GN build
22-
checked in. As of this writing, it's not yet functional at all. Check back
23-
in a few weeks!
24-
25-
`GN <https://gn.googlesource.com/gn/>`_ is another metabuild system. It always
21+
`GN <https://gn.googlesource.com/gn/>`_ is a metabuild system. It always
2622
creates ninja files, but it can create some IDE projects (MSVC, Xcode, ...)
2723
which then shell out to ninja for the actual build.
2824

@@ -32,11 +28,6 @@ a 2000x difference), and since it's so fast it doesn't aggressively cache,
3228
making it possible to switch e.g. between release and debug builds in one build
3329
directory.
3430

35-
It is arguable easier to configure than the CMake build, and has native support
36-
for building with multiple toolchains in one build directory. The build
37-
description is declarative-ish, allowing GN to print it in a json format that
38-
can fairly easily be converted to other metabuild system inputs.
39-
4031
The main motivation behind the GN build is that some people find it more
4132
convenient for day-to-day hacking on LLVM than CMake. Distribution, building
4233
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://docs.google.com/presentation/d/15Zwb53Jc
4940
Quick start
5041
===========
5142

52-
*Warning* Right now, we're in the process of getting the GN build checked in.
53-
As of this writing, it's not yet functional at all.
54-
5543
GN only works in the monorepo layout.
5644

5745
#. Obtain a `gn binary <https://gn.googlesource.com/gn/#getting-started>`_.
@@ -61,8 +49,8 @@ GN only works in the monorepo layout.
6149
build directory, it can have any name, and you can have as many as you want,
6250
each with different build settings).
6351

64-
#. Run e.g. `ninja -C out/gn llvm-undname` to build all prerequisites for and
65-
including the Microsoft symbol name pretty printing tool llvm-undname.
52+
#. Run e.g. `ninja -C out/gn check-lld` to build all prerequisites for and
53+
run the LLD tests.
6654

6755
By default, you get a release build with assertions enabled that targets
6856
the host arch. You can set various build options by editing `out/gn/args.gn`,

0 commit comments

Comments
 (0)