Remove absolute paths from build command lines
The GN convention is to specify paths in command lines relative to the
build directory. Unfortunately and contrary to pigweed's expectations
this is not what rebase_path(path) does; that outputs an absolute path.
Absolute paths are not desirable in most circumstances as they contain
sources of nondeterminism such as the developer's home directory. Using
them can for example reduce hit rate in build caches.
Replace rebase_path(path) with rebase_path(path, root_build_dir) which
is the correct idiom and matches GN's builtin behavior (e.g. for
sources, include_dirs, etc).
This also removes the --directory argument to python_action(). Changing
the directory during the build while using relative paths is likely to
result in confusion and should be discouraged.
There's a couple more things to do on top of this for identical
binaries between build directories / machines / developers:
- pass options to avoid embedding the working directory
- pass options to use relative paths for the vendored clang & libc++
See [1]-[2] for how to do that.
[1] https://source.chromium.org/chromium/chromium/src/+/main:build/config/compiler/BUILD.gn;l=1170-1239;drc=ab531c265c533cba1c2f6d8240cc0bf7679f605a
[2] https://cs.opensource.google/fuchsia/fuchsia/+/main:build/config/BUILD.gn;l=145-216;drc=f6d705f0937c778d5d5f807a4580113612b02f5a
Change-Id: I17708102c03d6488d68c8571b6e9343191fd47de
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/47461
Reviewed-by: Wyatt Hepler <hepler@google.com>
Commit-Queue: Michael Spang <spang@google.com>
diff --git a/pw_build/docs.rst b/pw_build/docs.rst
index db3725d..7bf075b 100644
--- a/pw_build/docs.rst
+++ b/pw_build/docs.rst
@@ -162,8 +162,6 @@
specifying ``outputs``. If ``stamp`` is true, a generic output file is
used. If ``stamp`` is a file path, that file is used as a stamp file. Like any
output file, ``stamp`` must be in the build directory. Defaults to false.
-* ``directory``: Optional path. Change to this directory before executing the
- command. Paths in arguments may need to be adjusted.
* ``environment``: Optional list of strings. Environment variables to set,
passed as NAME=VALUE strings.
@@ -208,7 +206,7 @@
``TARGET_FILE`` only resolves GN target labels to their outputs. To resolve
paths generally, use the standard GN approach of applying the
- ``rebase_path(path)`` function. With default arguments, ``rebase_path``
+ ``rebase_path(path, root_build_dir)`` function. This function
converts the provided GN path or list of paths to be relative to the build
directory, from which all build commands and scripts are executed.
@@ -266,7 +264,7 @@
script = "py/postprocess_binary.py"
args = [
"--database",
- rebase_path("my/database.csv"),
+ rebase_path("my/database.csv", root_build_dir),
"--binary=<TARGET_FILE(//firmware/images:main)>",
]
stamp = true