gn build: Add gn.py wrapper script that adds --dotfile= and --root= parameters

Since people weren't enthused about moving the .gn file to the toplevel in
D56419, here's a script to make gn at least somewhat more pleasant to invoke
(useful for gn clean, gn args --list, gn desc, etc).

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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@351064 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/utils/gn/.gn b/utils/gn/.gn
index 86d2da97565b37e798b7f7f7b160fee81742c02c..746baf06c57d4f915e1efa3e7944179c792f3740 100644 (file)
--- a/utils/gn/.gn
+++ b/utils/gn/.gn
@@ -1,6 +1,6 @@
-# FIXME: Once it's possible to add files to the root directory of the
-# monorepo, move this file to there.  Until then, you need to pass
-# `--dotfile=llvm/utils/gn/.gn --root=.` to the `gn gen` command.
+# Since this can't be at the toplevel, you either need to pass
+# `--dotfile=llvm/utils/gn/.gn --root=.` to the `gn gen` command
+# or use llvm/utils/gn/build/gn.py which calls gn with these two flags added.
 
 buildconfig = "//llvm/utils/gn/build/BUILDCONFIG.gn"
 

diff --git a/utils/gn/README.rst b/utils/gn/README.rst
index b9a8a9198d59372330a4ed3b1e15b81e2493b7bf..cd87ef1c90db98c10fa6a4518d68acbecedc538a 100644 (file)
--- a/utils/gn/README.rst
+++ b/utils/gn/README.rst
@@ -44,10 +44,12 @@ GN only works in the monorepo layout.
 
 #. Obtain a `gn binary <https://gn.googlesource.com/gn/#getting-started>`_.
 
-#. In the root of the monorepo, run
-   `gn gen --dotfile=$PWD/llvm/utils/gn/.gn --root=. out/gn` (`out/gn` is the
-   build directory, it can have any name, and you can have as many as you want,
-   each with different build settings).
+#. In the root of the monorepo, run `llvm/utils/gn/build/gn.py gen out/gn`.
+   `out/gn` is the build directory, it can have any name, and you can have as
+   many as you want, each with different build settings.  (The `gn.py` script
+   adds `--dotfile=llvm/utils/gn/.gn --root=.` and just runs regular `gn`;
+   you can manually pass these parameters and not use the wrapper if you
+   prefer.)
 
 #. Run e.g. `ninja -C out/gn check-lld` to build all prerequisites for and
    run the LLD tests.
@@ -55,9 +57,9 @@ GN only works in the monorepo layout.
 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`,
 for example putting `is_debug = true` in there gives you a debug build. Run
-`gn args --list out/gn` to see a list of all possible options. After touching
-`out/gn/args.gn`, just run ninja, it will re-invoke gn before starting the
-build.
+`llvm/utils/gn/build/gn.py args --list out/gn` to see a list of all possible
+options. After touching `out/gn/args.gn`, just run ninja, it will re-invoke gn
+before starting the build.
 
 GN has extensive built-in help; try e.g. `gn help gen` to see the help
 for the `gen` command. The full GN reference is also `available online

diff --git a/utils/gn/gn.py b/utils/gn/gn.py
new file mode 100644 (file)
index 0000000..f80873b
--- /dev/null
+++ b/utils/gn/gn.py
@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+"""Calls `gn` with the right --dotfile= and --root= arguments for LLVM."""
+
+# GN normally expects a file called '.gn' at the root of the repository.
+# Since LLVM's GN build isn't supported, putting that file at the root
+# is deemed inappropriate, which requires passing --dotfile= and -root= to GN.
+# Since that gets old fast, this script automatically passes these arguments.
+
+import os
+import subprocess
+import sys
+
+
+THIS_DIR = os.path.dirname(__file__)
+ROOT_DIR = os.path.join(THIS_DIR, '..', '..', '..')
+
+
+def main():
+    # Find real gn executable. For now, just assume it's on PATH.
+    # FIXME: Probably need to append '.exe' on Windows.
+    gn = 'gn'
+
+    # Compute --dotfile= and --root= args to add.
+    extra_args = []
+    gn_main_arg = next((x for x in sys.argv[1:] if not x.startswith('-')), None)
+    if gn_main_arg != 'help':  # `gn help` gets confused by the switches.
+        cwd = os.getcwd()
+        dotfile = os.path.relpath(os.path.join(THIS_DIR, '.gn'), cwd)
+        root = os.path.relpath(ROOT_DIR, cwd)
+        extra_args = [ '--dotfile=' + dotfile, '--root=' + root ]
+
+    # Run GN command with --dotfile= and --root= added.
+    cmd = [gn] + extra_args + sys.argv[1:]
+    sys.exit(subprocess.call(cmd))
+
+
+if __name__ == '__main__':
+    main()