idf-build-apps
latest
Explanations
Sdkconfig & Config Rules
Find Command
Build Command
Dependency-Driven Build
Guides
Migration From 1.x to 2.x
References
Manifest File
.build-test-rules.yml
Configuration File
.idf_build_apps.toml
CLI Reference
API Reference
Others
Changelog
Contributions Guide
idf-build-apps
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
A
action (idf_build_apps.args.FieldMetadata attribute)
activate_completions() (in module idf_build_apps.autocompletions)
add_args_to_obj_doc_as_params() (in module idf_build_apps.args)
add_args_to_parser() (in module idf_build_apps.args)
add_test_case() (idf_build_apps.junit.report.TestSuite method)
(idf_build_apps.junit.TestSuite method)
App (class in idf_build_apps)
(class in idf_build_apps.app)
app (idf_build_apps.app.AppDeserializer attribute)
(idf_build_apps.AppDeserializer attribute)
app_dir (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
app_fmt (idf_build_apps.log.ColoredFormatter attribute)
AppDeserializer (class in idf_build_apps)
(class in idf_build_apps.app)
append_to_file() (in module idf_build_apps.autocompletions)
apply_config_file() (in module idf_build_apps.args)
AutocompleteActivationError
B
BaseArguments (class in idf_build_apps.args)
BaseModel (class in idf_build_apps.utils)
bold_red (idf_build_apps.log.ColoredFormatter attribute)
BoolExpr (class in idf_build_apps.manifest.if_parser)
BoolOrAnd (class in idf_build_apps.manifest.if_parser)
BoolStmt (class in idf_build_apps.manifest.if_parser)
BUILD (idf_build_apps.constants.BuildStage attribute)
build() (idf_build_apps.App method)
(idf_build_apps.app.App method)
build_apps() (in module idf_build_apps)
(in module idf_build_apps.main)
build_comment (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
build_dir (idf_build_apps.App property)
(idf_build_apps.app.App property)
(idf_build_apps.args.FindBuildArguments attribute)
build_log_filename (idf_build_apps.App property)
(idf_build_apps.app.App property)
(idf_build_apps.args.FindBuildArguments attribute)
build_log_path (idf_build_apps.App property)
(idf_build_apps.app.App property)
build_path (idf_build_apps.App property)
(idf_build_apps.app.App property)
build_status (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
build_system (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.app.CMakeApp attribute)
(idf_build_apps.app.MakeApp attribute)
(idf_build_apps.args.FindBuildArguments attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
build_verbose (idf_build_apps.args.BuildArguments attribute)
BuildArguments (class in idf_build_apps.args)
BuildError
BuildStage (class in idf_build_apps.constants)
BuildStatus (class in idf_build_apps.constants)
C
CAPS_HEADER_FILEPATTERN (idf_build_apps.manifest.soc_header.SocHeader attribute)
check_manifest_rules (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
CHECK_MANIFEST_RULES (idf_build_apps.manifest.manifest.Manifest attribute)
check_should_build() (idf_build_apps.App method)
(idf_build_apps.app.App method)
check_warnings (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.args.FindBuildArguments attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
ChipAttr (class in idf_build_apps.manifest.if_parser)
choices (idf_build_apps.args.FieldMetadata attribute)
clean() (idf_build_apps.session_args.SessionArgs method)
CMAKE_PROJECT_LINE (idf_build_apps.app.CMakeApp attribute)
(idf_build_apps.CMakeApp attribute)
cmake_vars (idf_build_apps.app.CMakeApp attribute)
(idf_build_apps.CMakeApp attribute)
CMakeApp (class in idf_build_apps)
(class in idf_build_apps.app)
collect_app_info (idf_build_apps.args.BuildArguments property)
collect_app_info_filename (idf_build_apps.args.BuildArguments attribute)
collect_size_info (idf_build_apps.args.BuildArguments property)
collect_size_info_filename (idf_build_apps.args.BuildArguments attribute)
ColoredFormatter (class in idf_build_apps.log)
compare_manifest_sha_filepath (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
config_name (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
config_rules (idf_build_apps.args.FindBuildArguments attribute)
config_rules_from_str() (in module idf_build_apps.utils)
ConfigFileSourceMixin (class in idf_build_apps.vendors.pydantic_sources)
ConfigRule (class in idf_build_apps.utils)
copy_sdkconfig (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.args.BuildArguments attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
create_test_report() (idf_build_apps.junit.report.TestReport method)
(idf_build_apps.junit.TestReport method)
D
datefmt (idf_build_apps.log.ColoredFormatter attribute)
deactivate_dependency_driven_build_by_components (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
deactivate_dependency_driven_build_by_filepatterns (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
default (idf_build_apps.args.FieldMetadata attribute)
default_build_targets (idf_build_apps.args.FindBuildArguments attribute)
DEFAULT_BUILD_TARGETS (idf_build_apps.manifest.manifest.FolderRule attribute)
DefaultRule (class in idf_build_apps.manifest.manifest)
dependency_driven_build_enabled (idf_build_apps.args.DependencyDrivenBuildArguments property)
DependencyDrivenBuildArguments (class in idf_build_apps.args)
depends_components (idf_build_apps.App property)
(idf_build_apps.app.App property)
depends_components() (idf_build_apps.manifest.manifest.Manifest method)
depends_filepatterns (idf_build_apps.App property)
(idf_build_apps.app.App property)
depends_filepatterns() (idf_build_apps.manifest.manifest.Manifest method)
deprecates (idf_build_apps.args.FieldMetadata attribute)
diff_sha_with_filepath() (idf_build_apps.manifest.manifest.Manifest method)
DISABLED (idf_build_apps.constants.BuildStatus attribute)
drop_none_kwargs() (in module idf_build_apps.utils)
dry_run (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.args.BuildArguments attribute)
(idf_build_apps.CMakeApp attribute)
DRY_RUN (idf_build_apps.constants.BuildStage attribute)
dry_run (idf_build_apps.MakeApp attribute)
dump_sha_values() (idf_build_apps.manifest.manifest.Manifest method)
DumpManifestShaArguments (class in idf_build_apps.args)
E
enable_build_targets() (idf_build_apps.manifest.manifest.FolderRule method)
(idf_build_apps.manifest.manifest.Manifest method)
enable_preview_targets (idf_build_apps.args.FindBuildArguments attribute)
enable_test_targets() (idf_build_apps.manifest.manifest.FolderRule method)
(idf_build_apps.manifest.manifest.Manifest method)
exclude (idf_build_apps.args.FindBuildArguments attribute)
F
FAILED (idf_build_apps.constants.BuildStatus attribute)
field() (in module idf_build_apps.args)
FieldMetadata (class in idf_build_apps.args)
files_matches_patterns() (in module idf_build_apps.utils)
find_apps() (in module idf_build_apps)
(in module idf_build_apps.main)
find_first_match() (in module idf_build_apps.utils)
FindArguments (class in idf_build_apps.args)
FindBuildArguments (class in idf_build_apps.args)
fmt (idf_build_apps.log.ColoredFormatter attribute)
FolderRule (class in idf_build_apps.manifest.manifest)
format() (idf_build_apps.log.ColoredFormatter method)
FORMATS (idf_build_apps.log.ColoredFormatter attribute)
from_another() (idf_build_apps.App class method)
(idf_build_apps.app.App class method)
from_app() (idf_build_apps.junit.report.TestCase class method)
(idf_build_apps.junit.TestCase class method)
from_file() (idf_build_apps.manifest.manifest.Manifest class method)
from_files() (idf_build_apps.manifest.manifest.Manifest class method)
from_json() (idf_build_apps.app.AppDeserializer class method)
(idf_build_apps.AppDeserializer class method)
FULL_NAME_PLACEHOLDER (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
G
get_defines() (in module idf_build_apps.manifest.soc_header)
get_meta() (in module idf_build_apps.args)
get_parallel_start_stop() (in module idf_build_apps.utils)
get_parser() (in module idf_build_apps.main)
get_processor_name() (in module idf_build_apps.junit.utils)
get_size() (in module idf_build_apps.junit.utils)
get_sys_info() (in module idf_build_apps.junit.utils)
get_value() (idf_build_apps.manifest.if_parser.BoolOrAnd method)
(idf_build_apps.manifest.if_parser.BoolStmt method)
(idf_build_apps.manifest.if_parser.ChipAttr method)
(idf_build_apps.manifest.if_parser.Integer method)
(idf_build_apps.manifest.if_parser.List_ method)
(idf_build_apps.manifest.if_parser.Stmt method)
(idf_build_apps.manifest.if_parser.String method)
(idf_build_apps.manifest.manifest.IfClause method)
(idf_build_apps.manifest.manifest.SwitchClause method)
GlobalArguments (class in idf_build_apps.args)
grey (idf_build_apps.log.ColoredFormatter attribute)
H
handle_completions() (in module idf_build_apps.main)
hidden (idf_build_apps.args.FieldMetadata attribute)
I
idf_build_apps
module
idf_build_apps.app
module
idf_build_apps.args
module
idf_build_apps.autocompletions
module
idf_build_apps.constants
module
idf_build_apps.finder
module
idf_build_apps.junit
module
idf_build_apps.junit.report
module
idf_build_apps.junit.utils
module
idf_build_apps.log
module
idf_build_apps.main
module
idf_build_apps.manifest
module
idf_build_apps.manifest.if_parser
module
idf_build_apps.manifest.manifest
module
idf_build_apps.manifest.soc_header
module
idf_build_apps.session_args
module
idf_build_apps.utils
module
idf_build_apps.vendors
module
idf_build_apps.vendors.pydantic_sources
module
idf_build_apps.yaml
module
idf_build_apps.yaml.parser
module
IDF_VERSION_PLACEHOLDER (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
IdfBuildAppsCliFormatter (class in idf_build_apps.main)
IfClause (class in idf_build_apps.manifest.manifest)
ignore_warning_files (idf_build_apps.args.BuildArguments attribute)
ignore_warning_strs (idf_build_apps.args.BuildArguments attribute)
IGNORE_WARNS_REGEXES (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
include_all_apps (idf_build_apps.args.FindBuildArguments attribute)
include_disabled_apps (idf_build_apps.args.FindBuildArguments attribute)
include_skipped_apps (idf_build_apps.args.FindBuildArguments attribute)
index (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
INDEX_PLACEHOLDER (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
Integer (class in idf_build_apps.manifest.if_parser)
InvalidCommand
InvalidIfClause
InvalidInput
InvalidManifest
is_app() (idf_build_apps.App class method)
(idf_build_apps.app.App class method)
(idf_build_apps.app.CMakeApp class method)
(idf_build_apps.app.MakeApp class method)
(idf_build_apps.CMakeApp class method)
(idf_build_apps.MakeApp class method)
is_error (idf_build_apps.junit.report.TestCase property)
(idf_build_apps.junit.TestCase property)
is_error_or_warning() (idf_build_apps.App method)
(idf_build_apps.app.App method)
is_failed (idf_build_apps.junit.report.TestCase property)
(idf_build_apps.junit.TestCase property)
is_modified() (idf_build_apps.App method)
(idf_build_apps.app.App method)
is_skipped (idf_build_apps.junit.report.TestCase property)
(idf_build_apps.junit.TestCase property)
J
json_to_app() (in module idf_build_apps)
(in module idf_build_apps.main)
junitxml (idf_build_apps.args.BuildArguments property)
junitxml_filename (idf_build_apps.args.BuildArguments attribute)
K
keep_going (idf_build_apps.args.BuildArguments attribute)
L
LINE_SEP (idf_build_apps.main.IdfBuildAppsCliFormatter attribute)
List_ (class in idf_build_apps.manifest.if_parser)
LOG_DEBUG_LINES (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
LOG_ERROR_WARNING_REGEX (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
log_file (idf_build_apps.args.GlobalArguments attribute)
M
main() (in module idf_build_apps.main)
MAKE_PROJECT_LINE (idf_build_apps.app.MakeApp attribute)
(idf_build_apps.MakeApp attribute)
MakeApp (class in idf_build_apps)
(class in idf_build_apps.app)
Manifest (class in idf_build_apps.manifest.manifest)
MANIFEST (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
manifest_filepatterns (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
manifest_files (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
(idf_build_apps.args.DumpManifestShaArguments attribute)
manifest_rootpath (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
max_length() (idf_build_apps.constants.BuildStage class method)
modified_components (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
modified_files (idf_build_apps.args.DependencyDrivenBuildArguments attribute)
modified_manifest_rules_folders (idf_build_apps.args.DependencyDrivenBuildArguments property)
module
idf_build_apps
idf_build_apps.app
idf_build_apps.args
idf_build_apps.autocompletions
idf_build_apps.constants
idf_build_apps.finder
idf_build_apps.junit
idf_build_apps.junit.report
idf_build_apps.junit.utils
idf_build_apps.log
idf_build_apps.main
idf_build_apps.manifest
idf_build_apps.manifest.if_parser
idf_build_apps.manifest.manifest
idf_build_apps.manifest.soc_header
idf_build_apps.session_args
idf_build_apps.utils
idf_build_apps.vendors
idf_build_apps.vendors.pydantic_sources
idf_build_apps.yaml
idf_build_apps.yaml.parser
most_suitable_rule() (idf_build_apps.manifest.manifest.Manifest method)
N
name (idf_build_apps.App property)
(idf_build_apps.app.App property)
NAME_PLACEHOLDER (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
nargs (idf_build_apps.args.FieldMetadata attribute)
no_color (idf_build_apps.args.GlobalArguments attribute)
no_preserve (idf_build_apps.args.BuildArguments attribute)
O
output (idf_build_apps.args.DumpManifestShaArguments attribute)
(idf_build_apps.args.FindArguments attribute)
output_format (idf_build_apps.args.FindArguments attribute)
override_sdkconfig_file_path (idf_build_apps.session_args.SessionArgs attribute)
override_sdkconfig_files (idf_build_apps.args.FindBuildArguments attribute)
override_sdkconfig_items (idf_build_apps.args.FindBuildArguments attribute)
(idf_build_apps.session_args.SessionArgs attribute)
P
parallel_count (idf_build_apps.args.BuildArguments attribute)
parallel_index (idf_build_apps.args.BuildArguments attribute)
PARALLEL_INDEX_PLACEHOLDER (idf_build_apps.args.BuildArguments attribute)
parse() (in module idf_build_apps.yaml)
(in module idf_build_apps.yaml.parser)
parse_define() (in module idf_build_apps.manifest.soc_header)
parse_postfixes() (in module idf_build_apps.yaml.parser)
paths (idf_build_apps.args.FindBuildArguments attribute)
POST_BUILD (idf_build_apps.constants.BuildStage attribute)
PRE_BUILD (idf_build_apps.constants.BuildStage attribute)
preserve (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
PyprojectTomlConfigSettingsSource (class in idf_build_apps.vendors.pydantic_sources)
R
record_build_duration() (idf_build_apps.App method)
(idf_build_apps.app.App method)
recursive (idf_build_apps.args.FindBuildArguments attribute)
red (idf_build_apps.log.ColoredFormatter attribute)
required (idf_build_apps.args.FieldMetadata attribute)
reset (idf_build_apps.log.ColoredFormatter attribute)
rmdir() (in module idf_build_apps.utils)
S
sdkconfig_defaults (idf_build_apps.args.FindBuildArguments attribute)
sdkconfig_defaults_candidates (idf_build_apps.App property)
(idf_build_apps.app.App property)
sdkconfig_defaults_str (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
sdkconfig_files (idf_build_apps.App property)
(idf_build_apps.app.App property)
sdkconfig_files_defined_idf_target (idf_build_apps.App property)
(idf_build_apps.app.App property)
SDKCONFIG_IGNORE_OPTS (idf_build_apps.app.CMakeApp attribute)
(idf_build_apps.CMakeApp attribute)
SDKCONFIG_LINE_REGEX (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
sdkconfig_path (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
SDKCONFIG_TEST_OPTS (idf_build_apps.app.CMakeApp attribute)
(idf_build_apps.CMakeApp attribute)
semicolon_separated_str_to_list() (in module idf_build_apps.utils)
SessionArgs (class in idf_build_apps.session_args)
set() (idf_build_apps.session_args.SessionArgs method)
settings_customise_sources() (idf_build_apps.args.BaseArguments class method)
setup_logging() (in module idf_build_apps)
(in module idf_build_apps.log)
sha (idf_build_apps.manifest.manifest.FolderRule property)
shorthand (idf_build_apps.args.FieldMetadata attribute)
SHOULD_BE_BUILT (idf_build_apps.constants.BuildStatus attribute)
size_json_filename (idf_build_apps.App property)
(idf_build_apps.app.App property)
(idf_build_apps.args.FindBuildArguments attribute)
size_json_path (idf_build_apps.App property)
(idf_build_apps.app.App property)
SKIPPED (idf_build_apps.constants.BuildStatus attribute)
SocHeader (class in idf_build_apps.manifest.soc_header)
Stmt (class in idf_build_apps.manifest.if_parser)
String (class in idf_build_apps.manifest.if_parser)
subprocess_run() (in module idf_build_apps.utils)
SUCCESS (idf_build_apps.constants.BuildStatus attribute)
supported_targets (idf_build_apps.App property)
(idf_build_apps.app.App property)
(idf_build_apps.app.MakeApp property)
(idf_build_apps.MakeApp property)
SwitchClause (class in idf_build_apps.manifest.manifest)
T
target (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.args.FindBuildArguments attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
TARGET_PLACEHOLDER (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
TestCase (class in idf_build_apps.junit)
(class in idf_build_apps.junit.report)
TestReport (class in idf_build_apps.junit)
(class in idf_build_apps.junit.report)
TestSuite (class in idf_build_apps.junit)
(class in idf_build_apps.junit.report)
to_absolute_path() (in module idf_build_apps.utils)
to_json() (idf_build_apps.App method)
(idf_build_apps.app.App method)
TO_LIST (idf_build_apps.args.ValidateMethod attribute)
to_list() (in module idf_build_apps.utils)
to_set() (in module idf_build_apps.utils)
to_version() (in module idf_build_apps.utils)
to_xml_elem() (idf_build_apps.junit.report.TestCase method)
(idf_build_apps.junit.report.TestSuite method)
(idf_build_apps.junit.TestCase method)
(idf_build_apps.junit.TestSuite method)
TomlConfigSettingsSource (class in idf_build_apps.vendors.pydantic_sources)
type (idf_build_apps.args.FieldMetadata attribute)
U
UNKNOWN (idf_build_apps.constants.BuildStatus attribute)
V
validate_by_validate_methods() (idf_build_apps.args.BaseArguments class method)
validate_method (idf_build_apps.args.FieldMetadata attribute)
ValidateMethod (class in idf_build_apps.args)
verbose (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
(idf_build_apps.args.GlobalArguments attribute)
(idf_build_apps.CMakeApp attribute)
(idf_build_apps.MakeApp attribute)
verified_targets (idf_build_apps.App property)
(idf_build_apps.app.App property)
W
WILDCARD_PLACEHOLDER (idf_build_apps.App attribute)
(idf_build_apps.app.App attribute)
work_dir (idf_build_apps.App property)
(idf_build_apps.app.App property)
(idf_build_apps.args.FindBuildArguments attribute)
workdir (idf_build_apps.session_args.SessionArgs attribute)
write_size_json() (idf_build_apps.App method)
(idf_build_apps.app.App method)
Y
yellow (idf_build_apps.log.ColoredFormatter attribute)
Read the Docs
v: latest
Versions
latest
stable
release-v1.x
Downloads
On Read the Docs
Project Home
Builds