blob: 306ce8c7365c00fe5712074348707795206a52ee [file] [log] [blame]
# Copyright 2020 The Pigweed Authors
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
# This BUILDCONFIG file tells GN how to build upstream Pigweed. When starting a
# new project, you'll need to copy this file to your project and then modify it
# to fit your needs. Due to the way Pigweed handles file imports, you won't be
# able to simply import this file in your own
# Keep in mind when importing .gni files that `gn format` will try to
# alphabetically sort imports unless they're separated by comments. For this
# file, import order matters (modules.gni MUST be imported first).
declare_args() {
# Location of the Pigweed modules directory (defaults to the directory of
# this file). When copying this buildconfig into a new project, this should
# be modified to point to the location of the Pigweed repository.
dir_pigweed = get_path_info(get_path_info("", "abspath"), "dir")
# Path to the Pigweed variables config file for the build target.
# When this is changed, you must run `ninja -t clean` to remove any files from
# the previous target's build before building again.
pw_target_config = "$dir_pigweed/targets/host/target_config.gni"
# Import variables that provide paths to modules. Pigweed's GN build requires
# that this file is imported, and it MUST be imported before any other Pigweed
# .gni files (as they depend on the dir_[module] variables).
# Import target configuration. This is what "completes" a Pigweed configuration.
# This file should set a default toolchain, configure pw_executable, select
# backends to build against, and provide target-specific build arguments.
# Ensure some sort of default toolchain was provided by the target, and then
# set the default toolchain.
assert(pw_target_toolchain != "",
"Build target must provide its own toolchain.")
# The default toolchain is not used in Pigweed builds, so it is set to a dummy
# toolchain. The top-level should stamp a group with all of the build
# targets and their toolchains.