ceedling 1.2.1 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +11 -9
- data/Rakefile +2 -1
- data/assets/features/ceedling +1 -1
- data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
- data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
- data/bin/actionator.rb +6 -12
- data/bin/app_cfg.rb +14 -1
- data/bin/ceedling +13 -3
- data/bin/cli.rb +25 -6
- data/bin/cli_handler.rb +113 -73
- data/bin/cli_helper.rb +51 -78
- data/bin/installation_selector.rb +81 -0
- data/bin/launchinator.rb +69 -0
- data/bin/mixin_resolvinator.rb +26 -36
- data/bin/objects.yml +13 -0
- data/bin/path_validator.rb +25 -29
- data/bin/versionator.rb +47 -48
- data/ceedling.gemspec +19 -15
- data/docs/BreakingChanges.md +86 -1
- data/docs/Changelog.md +145 -3
- data/docs/KnownIssues.md +179 -6
- data/docs/ReleaseNotes.md +13 -0
- data/examples/wondrous_forest/README.md +29 -1
- data/examples/wondrous_forest/src/ForestUnits.h +23 -0
- data/examples/wondrous_forest/src/RainGauge.c +59 -0
- data/examples/wondrous_forest/src/RainGauge.h +39 -0
- data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
- data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
- data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
- data/lib/ceedling/build_log_writer.rb +33 -0
- data/lib/ceedling/c_extractor/README.md +15 -7
- data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
- data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
- data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
- data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
- data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
- data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
- data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
- data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
- data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
- data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
- data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
- data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
- data/lib/ceedling/c_identifier.rb +21 -0
- data/lib/ceedling/ceedling.h +8 -0
- data/lib/ceedling/config/build_root_policy.rb +70 -0
- data/lib/ceedling/config/configurator.rb +18 -19
- data/lib/ceedling/config/configurator_builder.rb +75 -28
- data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
- data/lib/ceedling/config/configurator_plugins.rb +1 -1
- data/lib/ceedling/config/configurator_setup.rb +44 -33
- data/lib/ceedling/config/configurator_validator.rb +1 -110
- data/lib/ceedling/constants.rb +5 -1
- data/lib/ceedling/defaults.rb +35 -5
- data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
- data/lib/ceedling/dependencies/README.md +18 -16
- data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
- data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
- data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
- data/lib/ceedling/dependencies/dependinator.rb +13 -1
- data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
- data/lib/ceedling/diagnostics/README.md +5 -0
- data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
- data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
- data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
- data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
- data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
- data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
- data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
- data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
- data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
- data/lib/ceedling/filename_extension.rb +7 -1
- data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
- data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
- data/lib/ceedling/filesystem/README.md +46 -0
- data/lib/ceedling/filesystem/build_roots.rb +105 -0
- data/lib/ceedling/filesystem/build_subpath.rb +187 -0
- data/lib/ceedling/filesystem/destination_collision.rb +25 -0
- data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
- data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
- data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
- data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
- data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
- data/lib/ceedling/filesystem/file_tree.rb +241 -0
- data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
- data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
- data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
- data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
- data/lib/ceedling/filesystem/path_spellings.rb +55 -0
- data/lib/ceedling/filesystem/project_paths.rb +184 -0
- data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
- data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
- data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
- data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
- data/lib/ceedling/filesystem/working_dir.rb +40 -0
- data/lib/ceedling/generators/generator.rb +32 -70
- data/lib/ceedling/generators/generator_helper.rb +0 -44
- data/lib/ceedling/generators/generator_mocks.rb +5 -0
- data/lib/ceedling/generators/generator_partials.rb +306 -244
- data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
- data/lib/ceedling/generators/generator_test_runner.rb +5 -8
- data/lib/ceedling/generators/partial_header_writer.rb +95 -0
- data/lib/ceedling/generators/partial_source_writer.rb +137 -0
- data/lib/ceedling/handoff.rb +121 -0
- data/lib/ceedling/includes/header_search.rb +225 -0
- data/lib/ceedling/includes/include_factory.rb +9 -12
- data/lib/ceedling/includes/include_pathinator.rb +112 -33
- data/lib/ceedling/includes/includes.rb +150 -38
- data/lib/ceedling/installation.rb +92 -0
- data/lib/ceedling/library_resolver.rb +99 -0
- data/lib/ceedling/objects.yml +112 -6
- data/lib/ceedling/partials/README.md +110 -16
- data/lib/ceedling/partials/carry_plan.rb +71 -0
- data/lib/ceedling/partials/definition_head.rb +74 -0
- data/lib/ceedling/partials/include_groups.rb +37 -0
- data/lib/ceedling/partials/interface_extras.rb +25 -0
- data/lib/ceedling/partials/partializer.rb +603 -124
- data/lib/ceedling/partials/partializer_config.rb +8 -1
- data/lib/ceedling/partials/partializer_helper.rb +851 -145
- data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
- data/lib/ceedling/partials/partializer_utils.rb +89 -109
- data/lib/ceedling/partials/partials.rb +153 -10
- data/lib/ceedling/partials/type_macros.rb +126 -0
- data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
- data/lib/ceedling/preprocess/README.md +43 -33
- data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
- data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
- data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
- data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
- data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
- data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
- data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
- data/lib/ceedling/rakefile.rb +15 -1
- data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
- data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
- data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
- data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
- data/lib/ceedling/reportinator.rb +3 -4
- data/lib/ceedling/setupinator.rb +104 -87
- data/lib/ceedling/test_context_extractor.rb +5 -1
- data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
- data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
- data/lib/ceedling/test_invoker/README.md +1 -1
- data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
- data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
- data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
- data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
- data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
- data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
- data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
- data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
- data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
- data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
- data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
- data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
- data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
- data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
- data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
- data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
- data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
- data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
- data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
- data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
- data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
- data/lib/ceedling/tools/shell_quoting.rb +45 -0
- data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
- data/lib/ceedling/tools/tool_quoting.rb +79 -0
- data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
- data/lib/ceedling/yaml_wrapper.rb +3 -2
- data/lib/version.rb +1 -1
- data/plugins/bullseye/bullseye.rake +1 -3
- data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
- data/plugins/bullseye/lib/bullseye.rb +24 -9
- data/plugins/command_hooks/lib/command_hooks.rb +1 -1
- data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
- data/plugins/dependencies/config/defaults.yml +6 -6
- data/plugins/dependencies/dependencies.rake +4 -1
- data/plugins/dependencies/lib/dependencies.rb +18 -8
- data/plugins/dependencies/lib/dependency_spec.rb +17 -5
- data/plugins/fff/lib/fff.rb +79 -46
- data/plugins/fff/lib/fff_mock_generator.rb +12 -9
- data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
- data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
- data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
- data/plugins/gcov/config/defaults_gcov.rb +1 -1
- data/plugins/gcov/lib/console_reportinator.rb +28 -36
- data/plugins/gcov/lib/gcov.rb +9 -2
- data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
- data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
- data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
- data/plugins/module_generator/lib/module_generator.rb +3 -3
- data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
- data/plugins/sanitize/lib/sanitize_records.rb +3 -6
- data/plugins/valgrind/lib/valgrind.rb +14 -7
- data/site-local/404.html +2 -2
- data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
- data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
- data/site-local/configuration/environment-vars.html +2 -2
- data/site-local/configuration/global-collections.html +3 -3
- data/site-local/configuration/index.html +2 -2
- data/site-local/configuration/loading.html +2 -2
- data/site-local/configuration/mixins.html +2 -2
- data/site-local/configuration/parallel-builds.html +2 -2
- data/site-local/configuration/project-file.html +2 -2
- data/site-local/configuration/reference/cexception.html +2 -2
- data/site-local/configuration/reference/cmock.html +7 -3
- data/site-local/configuration/reference/defines.html +2 -2
- data/site-local/configuration/reference/environment.html +2 -2
- data/site-local/configuration/reference/extension.html +2 -2
- data/site-local/configuration/reference/files.html +65 -12
- data/site-local/configuration/reference/flags.html +2 -2
- data/site-local/configuration/reference/index.html +2 -2
- data/site-local/configuration/reference/libraries.html +23 -5
- data/site-local/configuration/reference/mixins.html +2 -2
- data/site-local/configuration/reference/partials.html +84 -2
- data/site-local/configuration/reference/paths.html +36 -8
- data/site-local/configuration/reference/plugins.html +2 -2
- data/site-local/configuration/reference/project.html +264 -12
- data/site-local/configuration/reference/release-build.html +4 -2
- data/site-local/configuration/reference/test-build.html +2 -2
- data/site-local/configuration/reference/test-runner.html +2 -2
- data/site-local/configuration/reference/tools.html +58 -4
- data/site-local/configuration/reference/unity.html +2 -2
- data/site-local/configuration/which-ceedling.html +379 -19
- data/site-local/development/index.html +2 -2
- data/site-local/development/plugins/configuration.html +2 -2
- data/site-local/development/plugins/index.html +2 -2
- data/site-local/development/plugins/plugin-subclass.html +5 -4
- data/site-local/development/plugins/rake-tasks.html +2 -2
- data/site-local/development/releases.html +7 -3
- data/site-local/development/workflow.html +50 -45
- data/site-local/getting-started/builds.html +4 -2
- data/site-local/getting-started/command-line.html +58 -6
- data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
- data/site-local/getting-started/example-projects/index.html +2 -2
- data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
- data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
- data/site-local/getting-started/index.html +2 -2
- data/site-local/getting-started/installation.html +2 -2
- data/site-local/getting-started/quick-start.html +2 -2
- data/site-local/help.html +2 -2
- data/site-local/index.html +2 -2
- data/site-local/overview/build-system.html +2 -2
- data/site-local/overview/index.html +2 -2
- data/site-local/overview/test-environments.html +2 -2
- data/site-local/overview/tools-and-frameworks.html +2 -2
- data/site-local/plugins/beep.html +2 -2
- data/site-local/plugins/bullseye/index.html +45 -38
- data/site-local/plugins/bullseye/licensing.html +2 -2
- data/site-local/plugins/command-hooks.html +4 -4
- data/site-local/plugins/compile-commands-json-db.html +2 -2
- data/site-local/plugins/cppcheck.html +2 -2
- data/site-local/plugins/dependencies.html +8 -5
- data/site-local/plugins/fff.html +58 -13
- data/site-local/plugins/gcov/examples.html +2 -2
- data/site-local/plugins/gcov/gcovr.html +23 -14
- data/site-local/plugins/gcov/index.html +2 -2
- data/site-local/plugins/gcov/overview.html +2 -2
- data/site-local/plugins/gcov/reportgenerator.html +18 -14
- data/site-local/plugins/gcov/reporting.html +2 -2
- data/site-local/plugins/gcov/setup.html +4 -3
- data/site-local/plugins/gcov/tool-versions.html +2 -2
- data/site-local/plugins/gcov/troubleshooting.html +2 -2
- data/site-local/plugins/index.html +2 -2
- data/site-local/plugins/module-generator.html +2 -2
- data/site-local/plugins/report-build-warnings-log.html +2 -2
- data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
- data/site-local/plugins/report-tests-ide-stdout.html +2 -2
- data/site-local/plugins/report-tests-log-factory.html +2 -2
- data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
- data/site-local/plugins/report-tests-raw-output-log.html +5 -3
- data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
- data/site-local/plugins/sanitize.html +9 -8
- data/site-local/plugins/valgrind.html +10 -9
- data/site-local/project/index.html +2 -2
- data/site-local/project/release-history.html +2 -2
- data/site-local/project/sbom.html +2 -2
- data/site-local/project/upgrade.html +5 -2
- data/site-local/reference/build-directives.html +2 -2
- data/site-local/reference/command-line.html +11 -4
- data/site-local/reference/environment-vars.html +2 -2
- data/site-local/reference/gcov-plugin.html +2 -2
- data/site-local/reference/global-collections.html +12 -12
- data/site-local/reference/index.html +2 -2
- data/site-local/reference/partials-macros.html +47 -2
- data/site-local/reference/project-configuration.html +2 -2
- data/site-local/sitemap.xml.gz +0 -0
- data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
- data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
- data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
- data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
- data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
- data/site-local/testing-guide/build-directives.html +2 -2
- data/site-local/testing-guide/conventions.html +113 -15
- data/site-local/testing-guide/frameworks.html +2 -2
- data/site-local/testing-guide/index.html +2 -2
- data/site-local/testing-guide/partials/configuration.html +31 -4
- data/site-local/testing-guide/partials/conventions.html +509 -8
- data/site-local/testing-guide/partials/directives.html +4 -3
- data/site-local/testing-guide/partials/example.html +2 -2
- data/site-local/testing-guide/partials/index.html +2 -2
- data/site-local/testing-guide/partials/overview.html +30 -12
- data/site-local/testing-guide/partials/variables.html +169 -4
- data/site-local/testing-guide/test-cases.html +2 -2
- data/site-local/testing-guide/test-sample.html +2 -2
- data/site-local/testing-guide/test-suite-anatomy.html +2 -2
- data/spec/integration/actionator_file_operations_spec.rb +91 -1
- data/spec/integration/build_step_doctor_spec.rb +270 -0
- data/spec/integration/c_extractor_composition_spec.rb +254 -4
- data/spec/integration/compile_commands_json_db_spec.rb +1 -1
- data/spec/integration/configurator_validation_spec.rb +1 -1
- data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
- data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
- data/spec/integration/includes_extraction_spec.rb +27 -14
- data/spec/integration/launcher_handoff_spec.rb +297 -0
- data/spec/integration/mixin_loading_spec.rb +1 -1
- data/spec/integration/module_generator_spec.rb +3 -3
- data/spec/integration/nested_test_artifacts_spec.rb +99 -0
- data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
- data/spec/integration/partials_carry_spec.rb +520 -0
- data/spec/integration/partials_declarations_spec.rb +655 -0
- data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
- data/spec/integration/partials_function_pointers_spec.rb +277 -0
- data/spec/integration/partials_header_composition_spec.rb +268 -35
- data/spec/integration/partials_macro_decorators_spec.rb +267 -0
- data/spec/integration/partials_module_resolution_spec.rb +33 -23
- data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
- data/spec/integration/path_intake_scenarios_spec.rb +101 -0
- data/spec/integration/path_length_reporting_spec.rb +64 -0
- data/spec/integration/path_scenarios_spec.rb +399 -0
- data/spec/integration/quote_include_isolator_spec.rb +57 -1
- data/spec/integration/report_build_warnings_log_spec.rb +1 -1
- data/spec/integration/report_tests_log_factory_spec.rb +1 -1
- data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
- data/spec/integration/test_executable_manifest_spec.rb +1 -1
- data/spec/integration/test_includes_extractinator_spec.rb +69 -3
- data/spec/integration/test_naming_spec.rb +201 -0
- data/spec/integration/test_source_file_checks_spec.rb +168 -0
- data/spec/integration/tool_executor_spec.rb +1 -1
- data/spec/integration/tool_validator_spec.rb +3 -3
- data/spec/integration/upgrade_docs_spec.rb +84 -0
- data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
- data/spec/integration/win_long_paths_probe_spec.rb +46 -0
- data/spec/integration/win_path_limit_spec.rb +53 -0
- data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
- data/spec/support/file_tree_helper.rb +88 -0
- data/spec/support/integration/configurator_integration_helper.rb +14 -9
- data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
- data/spec/support/integration/partial_files_harness.rb +181 -0
- data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
- data/spec/support/integration/path_scenario_harness.rb +175 -0
- data/spec/support/integration/spec_integration_helper.rb +9 -4
- data/spec/support/integration/test_includes_harness.rb +69 -37
- data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
- data/spec/support/spec_helper.rb +2 -0
- data/spec/support/system/spec_system_helper.rb +7 -6
- data/spec/support/system/system_context.rb +21 -3
- data/spec/support/working_dir_tracking.rb +49 -0
- data/spec/system/build_output_mirroring_spec.rb +2 -2
- data/spec/system/bullseye_deployment_spec.rb +2 -0
- data/spec/system/conditional_mock_includes_spec.rb +1 -1
- data/spec/system/delta_builds_spec.rb +163 -23
- data/spec/system/encoding_stress_spec.rb +4 -4
- data/spec/system/example_wondrous_forest_spec.rb +2 -2
- data/spec/system/gcov_deployment_spec.rb +3 -0
- data/spec/system/header_include_path_validation_spec.rb +4 -4
- data/spec/system/header_search_paths_spec.rb +1083 -0
- data/spec/system/launcher_handoff_spec.rb +82 -0
- data/spec/system/mock_include_folders_spec.rb +212 -0
- data/spec/system/mockable_header_reassembly_spec.rb +184 -0
- data/spec/system/parent_directory_reference_spec.rb +5 -3
- data/spec/system/partials_carry_spec.rb +581 -0
- data/spec/system/partials_delta_builds_spec.rb +280 -0
- data/spec/system/partials_function_pointers_spec.rb +106 -0
- data/spec/system/partials_macro_decorators_spec.rb +127 -0
- data/spec/system/partials_module_disambiguation_spec.rb +125 -0
- data/spec/system/path_handling_probes_spec.rb +196 -0
- data/spec/system/pinned_thread_count_spec.rb +4 -4
- data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
- data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
- data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
- data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
- data/spec/system/short_build_paths_spec.rb +87 -0
- data/spec/system/sibling_header_collision_spec.rb +30 -6
- data/spec/system/special_path_characters_spec.rb +86 -0
- data/spec/system/support/bullseye_common_test_cases.rb +42 -0
- data/spec/system/support/common_test_cases.rb +23 -21
- data/spec/system/support/gcov_common_test_cases.rb +37 -9
- data/spec/system/support/gcov_partials_test_cases.rb +48 -0
- data/spec/system/support/sanitize_common_test_cases.rb +2 -2
- data/spec/system/support/valgrind_common_test_cases.rb +12 -12
- data/spec/system/test_build_layout_spec.rb +209 -0
- data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
- data/spec/system/test_runner_system_include_spec.rb +1 -1
- data/spec/system/test_source_file_directive_spec.rb +64 -5
- data/spec/units/bin/actionator_spec.rb +14 -17
- data/spec/units/bin/app_cfg_spec.rb +37 -0
- data/spec/units/bin/cli_handler_spec.rb +282 -6
- data/spec/units/bin/cli_helper_spec.rb +116 -45
- data/spec/units/bin/installation_selector_spec.rb +114 -0
- data/spec/units/bin/launchinator_spec.rb +171 -0
- data/spec/units/bin/path_validator_spec.rb +10 -0
- data/spec/units/bin/versionator_spec.rb +38 -6
- data/spec/units/build_log_writer_spec.rb +57 -0
- data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
- data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
- data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
- data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
- data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
- data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
- data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
- data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
- data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
- data/spec/units/c_identifier_spec.rb +35 -0
- data/spec/units/config/build_root_policy_spec.rb +61 -0
- data/spec/units/config/configurator_builder_spec.rb +61 -6
- data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
- data/spec/units/config/configurator_setup_spec.rb +80 -68
- data/spec/units/config/configurator_spec.rb +54 -6
- data/spec/units/config/configurator_validator_spec.rb +1 -172
- data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
- data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
- data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
- data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
- data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
- data/spec/units/dependencies/dependinator_spec.rb +17 -2
- data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
- data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
- data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
- data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
- data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
- data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
- data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
- data/spec/units/encodinator_spec.rb +3 -4
- data/spec/units/filename_extension_spec.rb +11 -0
- data/spec/units/filesystem/build_roots_spec.rb +131 -0
- data/spec/units/filesystem/build_subpath_spec.rb +235 -0
- data/spec/units/filesystem/destination_collision_spec.rb +30 -0
- data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
- data/spec/units/filesystem/file_finder_spec.rb +845 -0
- data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
- data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
- data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
- data/spec/units/filesystem/file_tree_spec.rb +511 -0
- data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
- data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
- data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
- data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
- data/spec/units/filesystem/project_paths_spec.rb +147 -0
- data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
- data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
- data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
- data/spec/units/filesystem/working_dir_spec.rb +71 -0
- data/spec/units/generators/generator_helper_spec.rb +0 -60
- data/spec/units/generators/generator_mocks_spec.rb +13 -0
- data/spec/units/generators/generator_partials_spec.rb +656 -55
- data/spec/units/generators/generator_spec.rb +38 -6
- data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
- data/spec/units/generators/generator_test_results_spec.rb +1 -1
- data/spec/units/generators/generator_test_runner_spec.rb +9 -5
- data/spec/units/generators/partial_source_writer_spec.rb +129 -0
- data/spec/units/handoff_spec.rb +205 -0
- data/spec/units/includes/header_search_spec.rb +406 -0
- data/spec/units/includes/include_factory_spec.rb +23 -6
- data/spec/units/includes/include_pathinator_spec.rb +118 -8
- data/spec/units/includes/include_spec.rb +14 -0
- data/spec/units/includes/includes_spec.rb +176 -19
- data/spec/units/installation_spec.rb +228 -0
- data/spec/units/library_resolver_spec.rb +157 -0
- data/spec/units/loginator_spec.rb +31 -0
- data/spec/units/mock_locator_spec.rb +275 -6
- data/spec/units/partials/include_groups_spec.rb +42 -0
- data/spec/units/partials/partializer_config_spec.rb +32 -0
- data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
- data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
- data/spec/units/partials/partializer_helper_spec.rb +529 -277
- data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
- data/spec/units/partials/partializer_spec.rb +1579 -270
- data/spec/units/partials/partializer_utils_spec.rb +269 -232
- data/spec/units/partials/partials_rename_spec.rb +160 -0
- data/spec/units/partials_manager_spec.rb +561 -251
- data/spec/units/plugins/bullseye_spec.rb +49 -2
- data/spec/units/plugins/console_reportinator_spec.rb +73 -26
- data/spec/units/plugins/dependencies_spec.rb +33 -7
- data/spec/units/plugins/dependency_spec_spec.rb +17 -0
- data/spec/units/plugins/gcov_spec.rb +28 -3
- data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
- data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
- data/spec/units/plugins/module_generator_spec.rb +5 -5
- data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
- data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
- data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
- data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
- data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
- data/spec/units/plugins/sanitize_records_spec.rb +3 -1
- data/spec/units/plugins/sanitize_spec.rb +1 -1
- data/spec/units/plugins/valgrind_spec.rb +23 -8
- data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
- data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
- data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
- data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
- data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
- data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
- data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
- data/spec/units/release_build_executor_spec.rb +53 -14
- data/spec/units/release_build_planner_spec.rb +15 -3
- data/spec/units/reportinator_spec.rb +5 -5
- data/spec/units/setupinator_spec.rb +51 -0
- data/spec/units/standin_headerinator_spec.rb +55 -9
- data/spec/units/test_build_executor_spec.rb +842 -166
- data/spec/units/test_build_planner_spec.rb +205 -15
- data/spec/units/test_build_setup_spec.rb +179 -30
- data/spec/units/test_context_extractor_spec.rb +36 -2
- data/spec/units/test_derived_search_paths_spec.rb +259 -0
- data/spec/units/test_file_preprocessinator_spec.rb +17 -1
- data/spec/units/test_includes_extractinator_spec.rb +61 -9
- data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
- data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
- data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
- data/spec/units/test_invoker_spec.rb +14 -1
- data/spec/units/test_invoker_types_spec.rb +8 -7
- data/spec/units/test_pipeline_manager_spec.rb +54 -13
- data/spec/units/test_runner_generatinator_spec.rb +93 -1
- data/spec/units/test_search_paths_spec.rb +73 -5
- data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
- data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
- data/spec/units/tools/shell_quoting_spec.rb +76 -0
- data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
- data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
- data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
- data/spec/units/windows_registry_query_tool_spec.rb +53 -0
- data/spec/units/yaml_wrapper_spec.rb +11 -0
- metadata +265 -36
- data/lib/ceedling/file_finder_helper.rb +0 -127
- data/lib/ceedling/file_path_collection_utils.rb +0 -164
- data/spec/units/file_finder_spec.rb +0 -495
- /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -2067,6 +2067,28 @@
|
|
|
2067
2067
|
</span>
|
|
2068
2068
|
</a>
|
|
2069
2069
|
|
|
2070
|
+
</li>
|
|
2071
|
+
|
|
2072
|
+
<li class="md-nav__item">
|
|
2073
|
+
<a href="#suppress_redundant_decls" class="md-nav__link">
|
|
2074
|
+
<span class="md-ellipsis">
|
|
2075
|
+
|
|
2076
|
+
:suppress_redundant_decls
|
|
2077
|
+
|
|
2078
|
+
</span>
|
|
2079
|
+
</a>
|
|
2080
|
+
|
|
2081
|
+
</li>
|
|
2082
|
+
|
|
2083
|
+
<li class="md-nav__item">
|
|
2084
|
+
<a href="#extern_variables" class="md-nav__link">
|
|
2085
|
+
<span class="md-ellipsis">
|
|
2086
|
+
|
|
2087
|
+
:extern_variables
|
|
2088
|
+
|
|
2089
|
+
</span>
|
|
2090
|
+
</a>
|
|
2091
|
+
|
|
2070
2092
|
</li>
|
|
2071
2093
|
|
|
2072
2094
|
</ul>
|
|
@@ -4285,6 +4307,28 @@
|
|
|
4285
4307
|
</span>
|
|
4286
4308
|
</a>
|
|
4287
4309
|
|
|
4310
|
+
</li>
|
|
4311
|
+
|
|
4312
|
+
<li class="md-nav__item">
|
|
4313
|
+
<a href="#suppress_redundant_decls" class="md-nav__link">
|
|
4314
|
+
<span class="md-ellipsis">
|
|
4315
|
+
|
|
4316
|
+
:suppress_redundant_decls
|
|
4317
|
+
|
|
4318
|
+
</span>
|
|
4319
|
+
</a>
|
|
4320
|
+
|
|
4321
|
+
</li>
|
|
4322
|
+
|
|
4323
|
+
<li class="md-nav__item">
|
|
4324
|
+
<a href="#extern_variables" class="md-nav__link">
|
|
4325
|
+
<span class="md-ellipsis">
|
|
4326
|
+
|
|
4327
|
+
:extern_variables
|
|
4328
|
+
|
|
4329
|
+
</span>
|
|
4330
|
+
</a>
|
|
4331
|
+
|
|
4288
4332
|
</li>
|
|
4289
4333
|
|
|
4290
4334
|
</ul>
|
|
@@ -4380,6 +4424,12 @@
|
|
|
4380
4424
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="c1"># Ceiling of 1000 character blocks for buffer growth</span>
|
|
4381
4425
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="c1"># 8000 = a max buffer growth to 8,000,000 characters</span>
|
|
4382
4426
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">:max_extraction_length</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8000</span>
|
|
4427
|
+
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
|
|
4428
|
+
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="c1"># Write carried prototypes without GCC diagnostic pragmas</span>
|
|
4429
|
+
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="nt">:suppress_redundant_decls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">FALSE</span>
|
|
4430
|
+
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>
|
|
4431
|
+
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="c1"># Tests define the extern variables their modules only declare</span>
|
|
4432
|
+
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nt">:extern_variables</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:test</span>
|
|
4383
4433
|
</code></pre></div>
|
|
4384
4434
|
<h2 id="max_extraction_length"><code>:max_extraction_length</code></h2>
|
|
4385
4435
|
<p><strong><em>Note:</em></strong> The default should be sufficient for nearly all test builds. Modification should only be necessary on error.</p>
|
|
@@ -4396,6 +4446,38 @@ than <code>10</code> (10,000 characters).</p>
|
|
|
4396
4446
|
legitimately large single construct in your codebase (e.g. a sizable
|
|
4397
4447
|
lookup table). Ordinarily, there’s no reason to lower it.</p>
|
|
4398
4448
|
<p><strong>Default</strong>: 5000 (5,000,000 characters)</p>
|
|
4449
|
+
<h2 id="suppress_redundant_decls"><code>:suppress_redundant_decls</code></h2>
|
|
4450
|
+
<p>A Partial's implementation source carries prototypes that your module's code
|
|
4451
|
+
relies on, as described in
|
|
4452
|
+
<a href="../../testing-guide/partials/conventions.html#what-a-partial-carries-from-your-module">What a Partial carries from your module</a>.
|
|
4453
|
+
A carried prototype may repeat a declaration that one of your headers already
|
|
4454
|
+
makes. That is valid C, but GCC reports it under <code>-Wredundant-decls</code>, and
|
|
4455
|
+
<code>-Werror</code> turns the report into a failed build.</p>
|
|
4456
|
+
<p>With this setting enabled, Ceedling wraps each run of carried prototypes in
|
|
4457
|
+
GCC diagnostic pragmas. The pragmas quiet <code>-Wredundant-decls</code> for those lines
|
|
4458
|
+
alone, and they sit behind <code>#if defined(__GNUC__)</code>, so other compilers never
|
|
4459
|
+
see them. Disable the setting to write carried prototypes bare.</p>
|
|
4460
|
+
<p><strong>Default</strong>: <code>TRUE</code></p>
|
|
4461
|
+
<h2 id="extern_variables"><code>:extern_variables</code></h2>
|
|
4462
|
+
<p>A module may declare a variable <code>extern</code> that another module defines. A test
|
|
4463
|
+
built from a Partial may or may not link that other module, so the Partial's
|
|
4464
|
+
implementation source decides what to write for the variable.</p>
|
|
4465
|
+
<ul>
|
|
4466
|
+
<li><code>:weak</code> writes a weak definition. A real definition, from a linked module or
|
|
4467
|
+
from the test file, takes precedence over it. When nothing else defines the
|
|
4468
|
+
variable, the weak definition stands in, so the test links either way. The
|
|
4469
|
+
weak attribute sits behind <code>#if defined(__GNUC__)</code>. Other compilers get a
|
|
4470
|
+
plain definition, which collides with a real one. A test built with such a
|
|
4471
|
+
compiler that links the defining module needs <code>:test</code>.</li>
|
|
4472
|
+
<li><code>:test</code> writes no definition. The test file, or a module the test links,
|
|
4473
|
+
must define the variable.</li>
|
|
4474
|
+
</ul>
|
|
4475
|
+
<p>A variable your module defines itself is written where your module defines
|
|
4476
|
+
it, whatever this setting says. A variable whose struct or union type your
|
|
4477
|
+
module never completes gets no definition under either setting, since no
|
|
4478
|
+
definition of an incomplete type compiles. The module that completes the type
|
|
4479
|
+
must define the variable.</p>
|
|
4480
|
+
<p><strong>Default</strong>: <code>:weak</code></p>
|
|
4399
4481
|
<p><br/><br/></p>
|
|
4400
4482
|
|
|
4401
4483
|
|
|
@@ -4467,7 +4549,7 @@ lookup table). Ordinarily, there’s no reason to lower it.</p>
|
|
|
4467
4549
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4468
4550
|
|
|
4469
4551
|
|
|
4470
|
-
<script src="../../assets/javascripts/bundle.
|
|
4552
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4471
4553
|
|
|
4472
4554
|
|
|
4473
4555
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4799,6 +4799,11 @@ file search paths:</p>
|
|
|
4799
4799
|
<p>This set of paths specifies the locations of your header files. If your header
|
|
4800
4800
|
files are intermixed with source files, you must duplicate some or all of your
|
|
4801
4801
|
<code>:paths</code> ↳ <code>:source</code> entries here.</p>
|
|
4802
|
+
<p>A search path reaches the headers in directories below it through the path an
|
|
4803
|
+
<code>#include</code> names, as your compiler does. With <code>src/</code> listed,
|
|
4804
|
+
<code>#include "drivers/uart.h"</code> and <code>#include "drivers/mock_uart.h"</code> both find
|
|
4805
|
+
<code>src/drivers/uart.h</code>. A glob such as <code>src/**</code> is needed only for an <code>#include</code>
|
|
4806
|
+
that names a header below <code>src/</code> by its filename alone.</p>
|
|
4802
4807
|
<p>In its simplest use, your include paths list can be exhaustive. That is, you
|
|
4803
4808
|
list all path locations where your project’s header files reside in this
|
|
4804
4809
|
configuration list.</p>
|
|
@@ -4831,7 +4836,19 @@ files contained in those paths. A custom list is just that — a custom list of
|
|
|
4831
4836
|
paths.</p>
|
|
4832
4837
|
<h2 id="paths-configuration-options-notes"><code>:paths</code> configuration options & notes</h2>
|
|
4833
4838
|
<ol>
|
|
4834
|
-
<li>A path can be absolute (fully qualified) or relative
|
|
4839
|
+
<li>A path can be absolute (fully qualified) or relative. A relative path is relative to
|
|
4840
|
+
the working directory, where you run <code>ceedling</code>, not to your project file’s
|
|
4841
|
+
directory. For a project file named with <code>--project</code> from another directory, write
|
|
4842
|
+
its paths relative to that other directory.</li>
|
|
4843
|
+
<li><code>~</code> at the start of a path names your home directory. <code>~user</code> is a directory named
|
|
4844
|
+
<code>~user</code>.</li>
|
|
4845
|
+
<li>A path reached through a symlink names the place the symlink leads to, so two
|
|
4846
|
+
entries reaching one directory collect it once. Directories found below an entry
|
|
4847
|
+
keep the spelling they are found by, as an <code>#include</code> reaches them.</li>
|
|
4848
|
+
<li>An entry based above the build root, such as <code>./**</code> or <code>../**</code>, collects nothing
|
|
4849
|
+
from it. An entry within the build root collects from it with a warning, but no entry
|
|
4850
|
+
collects from the directories Ceedling and its plugins create, such as <code>test/</code>,
|
|
4851
|
+
<code>release/</code>, <code>vendor/</code>, and <code>artifacts/</code> below the build root, or the mocks directory.</li>
|
|
4835
4852
|
<li>A path can include a glob matcher (more on this below).</li>
|
|
4836
4853
|
<li>A path can use <a href="../project-file.html#inline-ruby-string-expansion">inline Ruby string expansion</a>.</li>
|
|
4837
4854
|
<li>Subtractive paths are possible and useful. See the documentation below.</li>
|
|
@@ -4883,6 +4900,17 @@ collection.</p>
|
|
|
4883
4900
|
<p>By default, paths are additive. For pretty alignment in your YAML, you may also
|
|
4884
4901
|
use <code>+:</code>, but strictly speaking, it’s not necessary.</p>
|
|
4885
4902
|
<p>Subtractive paths may be simple paths or globs just like any other path entry.</p>
|
|
4903
|
+
<p>A subtractive entry removes the directories it names and every directory below them.
|
|
4904
|
+
An additive entry naming one of those directories more closely keeps it:</p>
|
|
4905
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nt">:paths</span><span class="p">:</span>
|
|
4906
|
+
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">:source</span><span class="p">:</span>
|
|
4907
|
+
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">src/**</span>
|
|
4908
|
+
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">-:src/legacy</span><span class="w"> </span><span class="c1"># Removes src/legacy/ and every directory below it...</span>
|
|
4909
|
+
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">src/legacy/keep</span><span class="w"> </span><span class="c1"># ...except src/legacy/keep/, which this entry names</span>
|
|
4910
|
+
</code></pre></div>
|
|
4911
|
+
<p>A subtractive entry that names nothing logs a warning, so a mistyped entry does
|
|
4912
|
+
not pass unnoticed. Below the build root, where nothing exists before a first
|
|
4913
|
+
build, it passes without a word.</p>
|
|
4886
4914
|
<div class="admonition warning">
|
|
4887
4915
|
<p class="admonition-title">Quote the whole entry, decoration included</p>
|
|
4888
4916
|
<p>YAML keeps quote marks that begin partway through a value as part of the
|
|
@@ -4890,11 +4918,11 @@ value. Quoting only the path leaves quote marks in the path, and
|
|
|
4890
4918
|
Ceedling rejects the entry. Quote an entry whenever it holds <code>#{…}</code>
|
|
4891
4919
|
<a href="../project-file.html#inline-ruby-string-expansion">inline Ruby string expansion</a>, because YAML
|
|
4892
4920
|
otherwise reads the <code>#</code> as the start of a comment.</p>
|
|
4893
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-
|
|
4894
|
-
<a id="__codelineno-
|
|
4895
|
-
<a id="__codelineno-
|
|
4896
|
-
<a id="__codelineno-
|
|
4897
|
-
<a id="__codelineno-
|
|
4921
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Correct</span>
|
|
4922
|
+
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"-:#{ENV['SRC_ROOT']}/vendor/legacy"</span>
|
|
4923
|
+
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
|
|
4924
|
+
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># Incorrect -- the quote marks become part of the path</span>
|
|
4925
|
+
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">-:"#{ENV['SRC_ROOT']}/vendor/legacy"</span>
|
|
4898
4926
|
</code></pre></div>
|
|
4899
4927
|
</div>
|
|
4900
4928
|
<div class="admonition note">
|
|
@@ -4983,7 +5011,7 @@ a test executable’s own compile/link list.</p>
|
|
|
4983
5011
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4984
5012
|
|
|
4985
5013
|
|
|
4986
|
-
<script src="../../assets/javascripts/bundle.
|
|
5014
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4987
5015
|
|
|
4988
5016
|
|
|
4989
5017
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4505,7 +4505,7 @@ test results (usually <code>report_tests_pretty_stdout</code>).</p>
|
|
|
4505
4505
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4506
4506
|
|
|
4507
4507
|
|
|
4508
|
-
<script src="../../assets/javascripts/bundle.
|
|
4508
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4509
4509
|
|
|
4510
4510
|
|
|
4511
4511
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -2154,6 +2154,89 @@
|
|
|
2154
2154
|
</ul>
|
|
2155
2155
|
</nav>
|
|
2156
2156
|
|
|
2157
|
+
</li>
|
|
2158
|
+
|
|
2159
|
+
<li class="md-nav__item">
|
|
2160
|
+
<a href="#win_path_limit" class="md-nav__link">
|
|
2161
|
+
<span class="md-ellipsis">
|
|
2162
|
+
|
|
2163
|
+
:win_path_limit
|
|
2164
|
+
|
|
2165
|
+
</span>
|
|
2166
|
+
</a>
|
|
2167
|
+
|
|
2168
|
+
<nav class="md-nav" aria-label=":win_path_limit">
|
|
2169
|
+
<ul class="md-nav__list">
|
|
2170
|
+
|
|
2171
|
+
<li class="md-nav__item">
|
|
2172
|
+
<a href="#windows-two-limits" class="md-nav__link">
|
|
2173
|
+
<span class="md-ellipsis">
|
|
2174
|
+
|
|
2175
|
+
Windows‘ two limits
|
|
2176
|
+
|
|
2177
|
+
</span>
|
|
2178
|
+
</a>
|
|
2179
|
+
|
|
2180
|
+
</li>
|
|
2181
|
+
|
|
2182
|
+
<li class="md-nav__item">
|
|
2183
|
+
<a href="#classic" class="md-nav__link">
|
|
2184
|
+
<span class="md-ellipsis">
|
|
2185
|
+
|
|
2186
|
+
:classic
|
|
2187
|
+
|
|
2188
|
+
</span>
|
|
2189
|
+
</a>
|
|
2190
|
+
|
|
2191
|
+
</li>
|
|
2192
|
+
|
|
2193
|
+
<li class="md-nav__item">
|
|
2194
|
+
<a href="#long_paths" class="md-nav__link">
|
|
2195
|
+
<span class="md-ellipsis">
|
|
2196
|
+
|
|
2197
|
+
:long_paths
|
|
2198
|
+
|
|
2199
|
+
</span>
|
|
2200
|
+
</a>
|
|
2201
|
+
|
|
2202
|
+
</li>
|
|
2203
|
+
|
|
2204
|
+
<li class="md-nav__item">
|
|
2205
|
+
<a href="#auto" class="md-nav__link">
|
|
2206
|
+
<span class="md-ellipsis">
|
|
2207
|
+
|
|
2208
|
+
:auto
|
|
2209
|
+
|
|
2210
|
+
</span>
|
|
2211
|
+
</a>
|
|
2212
|
+
|
|
2213
|
+
</li>
|
|
2214
|
+
|
|
2215
|
+
<li class="md-nav__item">
|
|
2216
|
+
<a href="#ruby-before-40" class="md-nav__link">
|
|
2217
|
+
<span class="md-ellipsis">
|
|
2218
|
+
|
|
2219
|
+
Ruby before 4.0
|
|
2220
|
+
|
|
2221
|
+
</span>
|
|
2222
|
+
</a>
|
|
2223
|
+
|
|
2224
|
+
</li>
|
|
2225
|
+
|
|
2226
|
+
<li class="md-nav__item">
|
|
2227
|
+
<a href="#checking-your-toolchain" class="md-nav__link">
|
|
2228
|
+
<span class="md-ellipsis">
|
|
2229
|
+
|
|
2230
|
+
Checking your toolchain
|
|
2231
|
+
|
|
2232
|
+
</span>
|
|
2233
|
+
</a>
|
|
2234
|
+
|
|
2235
|
+
</li>
|
|
2236
|
+
|
|
2237
|
+
</ul>
|
|
2238
|
+
</nav>
|
|
2239
|
+
|
|
2157
2240
|
</li>
|
|
2158
2241
|
|
|
2159
2242
|
</ul>
|
|
@@ -4627,6 +4710,89 @@
|
|
|
4627
4710
|
</ul>
|
|
4628
4711
|
</nav>
|
|
4629
4712
|
|
|
4713
|
+
</li>
|
|
4714
|
+
|
|
4715
|
+
<li class="md-nav__item">
|
|
4716
|
+
<a href="#win_path_limit" class="md-nav__link">
|
|
4717
|
+
<span class="md-ellipsis">
|
|
4718
|
+
|
|
4719
|
+
:win_path_limit
|
|
4720
|
+
|
|
4721
|
+
</span>
|
|
4722
|
+
</a>
|
|
4723
|
+
|
|
4724
|
+
<nav class="md-nav" aria-label=":win_path_limit">
|
|
4725
|
+
<ul class="md-nav__list">
|
|
4726
|
+
|
|
4727
|
+
<li class="md-nav__item">
|
|
4728
|
+
<a href="#windows-two-limits" class="md-nav__link">
|
|
4729
|
+
<span class="md-ellipsis">
|
|
4730
|
+
|
|
4731
|
+
Windows‘ two limits
|
|
4732
|
+
|
|
4733
|
+
</span>
|
|
4734
|
+
</a>
|
|
4735
|
+
|
|
4736
|
+
</li>
|
|
4737
|
+
|
|
4738
|
+
<li class="md-nav__item">
|
|
4739
|
+
<a href="#classic" class="md-nav__link">
|
|
4740
|
+
<span class="md-ellipsis">
|
|
4741
|
+
|
|
4742
|
+
:classic
|
|
4743
|
+
|
|
4744
|
+
</span>
|
|
4745
|
+
</a>
|
|
4746
|
+
|
|
4747
|
+
</li>
|
|
4748
|
+
|
|
4749
|
+
<li class="md-nav__item">
|
|
4750
|
+
<a href="#long_paths" class="md-nav__link">
|
|
4751
|
+
<span class="md-ellipsis">
|
|
4752
|
+
|
|
4753
|
+
:long_paths
|
|
4754
|
+
|
|
4755
|
+
</span>
|
|
4756
|
+
</a>
|
|
4757
|
+
|
|
4758
|
+
</li>
|
|
4759
|
+
|
|
4760
|
+
<li class="md-nav__item">
|
|
4761
|
+
<a href="#auto" class="md-nav__link">
|
|
4762
|
+
<span class="md-ellipsis">
|
|
4763
|
+
|
|
4764
|
+
:auto
|
|
4765
|
+
|
|
4766
|
+
</span>
|
|
4767
|
+
</a>
|
|
4768
|
+
|
|
4769
|
+
</li>
|
|
4770
|
+
|
|
4771
|
+
<li class="md-nav__item">
|
|
4772
|
+
<a href="#ruby-before-40" class="md-nav__link">
|
|
4773
|
+
<span class="md-ellipsis">
|
|
4774
|
+
|
|
4775
|
+
Ruby before 4.0
|
|
4776
|
+
|
|
4777
|
+
</span>
|
|
4778
|
+
</a>
|
|
4779
|
+
|
|
4780
|
+
</li>
|
|
4781
|
+
|
|
4782
|
+
<li class="md-nav__item">
|
|
4783
|
+
<a href="#checking-your-toolchain" class="md-nav__link">
|
|
4784
|
+
<span class="md-ellipsis">
|
|
4785
|
+
|
|
4786
|
+
Checking your toolchain
|
|
4787
|
+
|
|
4788
|
+
</span>
|
|
4789
|
+
</a>
|
|
4790
|
+
|
|
4791
|
+
</li>
|
|
4792
|
+
|
|
4793
|
+
</ul>
|
|
4794
|
+
</nav>
|
|
4795
|
+
|
|
4630
4796
|
</li>
|
|
4631
4797
|
|
|
4632
4798
|
</ul>
|
|
@@ -4743,6 +4909,13 @@ output with the project name.</p>
|
|
|
4743
4909
|
</code></pre></div></p>
|
|
4744
4910
|
<h2 id="build_root"><code>:build_root</code></h2>
|
|
4745
4911
|
<p>Top level directory into which generated path structure and files are placed.</p>
|
|
4912
|
+
<p><code>ceedling clobber</code> empties the build root’s test and release trees, so Ceedling refuses a
|
|
4913
|
+
build root that is empty, the project directory, or a directory above it.</p>
|
|
4914
|
+
<p>An entry based above the build root, such as the <code>:paths</code> entry <code>../**</code> or the <code>:files</code>
|
|
4915
|
+
glob <code>+:**/*.c</code>, collects nothing from it. A <code>:paths</code> or <code>:files</code> entry within the build
|
|
4916
|
+
root, such as one naming generated code in <code>build/gen</code>, collects from it with a warning.
|
|
4917
|
+
No entry collects from the directories Ceedling and its plugins create there, such as
|
|
4918
|
+
<code>test/</code>, <code>release/</code>, <code>vendor/</code>, and <code>artifacts/</code>.</p>
|
|
4746
4919
|
<div class="admonition note">
|
|
4747
4920
|
<p class="admonition-title">Build configuration requirement</p>
|
|
4748
4921
|
<p>This is one of the handful of configuration values that must be set for
|
|
@@ -4772,7 +4945,7 @@ plugin tasks.</p>
|
|
|
4772
4945
|
<strong>Default</strong>: <code>['test:all']</code></p>
|
|
4773
4946
|
<h2 id="use_mocks"><code>:use_mocks</code></h2>
|
|
4774
4947
|
<p>Configures the build environment to make use of CMock. Note that if you do not
|
|
4775
|
-
use mocks, there
|
|
4948
|
+
use mocks, there’s no harm in leaving this setting as its default value.</p>
|
|
4776
4949
|
<p><strong>Default</strong>: TRUE</p>
|
|
4777
4950
|
<h2 id="use_exceptions"><code>:use_exceptions</code></h2>
|
|
4778
4951
|
<p>Configures the build environment to make use of CException. Ceedling enables
|
|
@@ -4834,7 +5007,7 @@ compilation, and running test executables.</p>
|
|
|
4834
5007
|
will drop considerably as compared to running a build with a single thread.</p>
|
|
4835
5008
|
<p>Tuning the number of threads for peak performance is an art more than a
|
|
4836
5009
|
science. A special value of <code>:auto</code> instructs Ceedling to query the host
|
|
4837
|
-
system
|
|
5010
|
+
system’s number of virtual cores. To this value it adds a constant of 4. This
|
|
4838
5011
|
is often a good value sufficient to "max out" available resources without
|
|
4839
5012
|
overloading available resources.</p>
|
|
4840
5013
|
<p><code>:compile_threads</code> is used for all release build steps and all test suite build
|
|
@@ -4855,9 +5028,11 @@ upon by test executables.</p>
|
|
|
4855
5028
|
<p><strong>Default</strong>: 1</p>
|
|
4856
5029
|
<h2 id="which_ceedling"><code>:which_ceedling</code></h2>
|
|
4857
5030
|
<p>This is an advanced project option primarily meant for development work on
|
|
4858
|
-
Ceedling itself. This setting
|
|
4859
|
-
|
|
4860
|
-
|
|
5031
|
+
Ceedling itself. This setting selects the Ceedling installation that runs
|
|
5032
|
+
your project’s commands. The <code>ceedling</code> command you run hands each command off to
|
|
5033
|
+
that installation’s own launcher.</p>
|
|
5034
|
+
<p>This entry can be either a directory path or <code>gem</code>. A relative path is
|
|
5035
|
+
relative to your working directory.</p>
|
|
4861
5036
|
<p>See the section <a href="../which-ceedling.html">Which Ceedling</a> for full details.</p>
|
|
4862
5037
|
<p><strong>Default</strong>: <code>gem</code></p>
|
|
4863
5038
|
<h2 id="use_backtrace"><code>:use_backtrace</code></h2>
|
|
@@ -4941,9 +5116,10 @@ with an error at startup.</p>
|
|
|
4941
5116
|
extracted from the <code>gdb</code> report. Ceedling will attempt to surface in the
|
|
4942
5117
|
summary the offending line of code or failing <code>assert()</code> from the report.</p>
|
|
4943
5118
|
<p>The full <code>gdb</code> report is captured to a log file, and the log filepath is
|
|
4944
|
-
provided in the crash summary. The log filepath
|
|
4945
|
-
|
|
4946
|
-
function as the filename
|
|
5119
|
+
provided in the crash summary. The log filepath comprises the <a href="../../testing-guide/conventions.html#test-names-build-output">test’s name</a>,
|
|
5120
|
+
its path from your project’s root, as a subdirectory plus the name of the crashing
|
|
5121
|
+
test case function as the filename. A build that logs a test case’s crash replaces
|
|
5122
|
+
that log; a log holds only the latest crash.</p>
|
|
4947
5123
|
<div class="admonition warning">
|
|
4948
5124
|
<p class="admonition-title">macOS: a working <code>gdb</code> can stop attaching to processes</p>
|
|
4949
5125
|
<p>macOS restricts which debuggers may attach to a process. A Homebrew <code>gdb</code>
|
|
@@ -4969,7 +5145,7 @@ build. To restore <code>:gdb</code> backtraces, re-codesign <code>gdb</code> fol
|
|
|
4969
5145
|
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a> Test: testCrash
|
|
4970
5146
|
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a> At line (40): "Test case crashed >> [SIGSEGV] Segmentation fault
|
|
4971
5147
|
<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a> `uint32_t i = *null_ptr;`
|
|
4972
|
-
<a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a> (build/logs/test/TestUsartModel/testCrash.gdb.log)"
|
|
5148
|
+
<a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a> (build/logs/test/test/TestUsartModel/testCrash.gdb.log)"
|
|
4973
5149
|
<a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a>
|
|
4974
5150
|
<a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a>-----------------------
|
|
4975
5151
|
<a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a>❌ OVERALL TEST SUMMARY
|
|
@@ -4985,13 +5161,89 @@ build. To restore <code>:gdb</code> backtraces, re-codesign <code>gdb</code> fol
|
|
|
4985
5161
|
command line arguments (passed to the test executable). If you are targeting
|
|
4986
5162
|
a simulator with your test executable binaries, <code>:simple</code> is unlikely to
|
|
4987
5163
|
work for you. In the simplest case, you may simply fall back to <code>:none</code>.
|
|
4988
|
-
With some work and using Ceedling
|
|
5164
|
+
With some work and using Ceedling’s various features, much more sophisticated
|
|
4989
5165
|
options are possible.</li>
|
|
4990
5166
|
<li>The <code>:gdb</code> option currently only supports the native build platform. That is,
|
|
4991
5167
|
the <code>:gdb</code> backtrace option cannot handle backtrace for cross-compiled code
|
|
4992
5168
|
or any sort of simulator-based test fixture.</li>
|
|
4993
5169
|
</ol>
|
|
4994
5170
|
<p><strong>Default</strong>: <code>:simple</code></p>
|
|
5171
|
+
<h2 id="win_path_limit"><code>:win_path_limit</code></h2>
|
|
5172
|
+
<p>Tells Ceedling which Windows path length limit applies to your build, so its
|
|
5173
|
+
path length messages are true for your host. It applies only on Windows, and
|
|
5174
|
+
Ceedling ignores it on other platforms. It is still checked on every host, so
|
|
5175
|
+
a project file shared across hosts is validated everywhere.</p>
|
|
5176
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nt">:project</span><span class="p">:</span>
|
|
5177
|
+
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">:win_path_limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:auto</span>
|
|
5178
|
+
</code></pre></div>
|
|
5179
|
+
<p>Ceedling checks the length of each build path it creates. A path near the
|
|
5180
|
+
limit gets a warning, and one at or past the limit gets an error. Each path is
|
|
5181
|
+
reported once. The messages never stop a build. A Windows path that is truly
|
|
5182
|
+
too long fails on its own, often as “No such file or directory” rather than a
|
|
5183
|
+
length error. Ceedling’s message is then the clue to the real cause.</p>
|
|
5184
|
+
<p>This setting changes only what Ceedling reports. It does not enable long-path
|
|
5185
|
+
safety. Long-paths on Windows requires a registry setting and application
|
|
5186
|
+
support.</p>
|
|
5187
|
+
<h3 id="windows-two-limits">Windows‘ two limits</h3>
|
|
5188
|
+
<ol>
|
|
5189
|
+
<li><strong>The classic limit, 260 characters.</strong> It applies on every Windows host
|
|
5190
|
+
unless long paths are in effect. A directory path maxes out at 248
|
|
5191
|
+
characters leaving room for a classic 8.3 filename within it.</li>
|
|
5192
|
+
<li><strong>Long paths, 32,767 characters.</strong> They are in effect for a program only
|
|
5193
|
+
when both of these hold:<ol>
|
|
5194
|
+
<li><a href="https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#registry-setting-to-enable-long-paths">Long paths are enabled on the host via registry setting</a>.
|
|
5195
|
+
Windows reads it when a program starts, so run Ceedling again after
|
|
5196
|
+
changing it.</li>
|
|
5197
|
+
<li>The program is long-path-aware, as its manifest declares. Every program
|
|
5198
|
+
decides this for itself: Ruby, your compiler, your linker.</li>
|
|
5199
|
+
</ol>
|
|
5200
|
+
</li>
|
|
5201
|
+
</ol>
|
|
5202
|
+
<p>In all cases, no single Windows directory or filename may exceed 255
|
|
5203
|
+
characters.</p>
|
|
5204
|
+
<h3 id="classic"><code>:classic</code></h3>
|
|
5205
|
+
<p>Reports paths against the classic limits: 260 characters for a file and 248
|
|
5206
|
+
for a directory. An error past the limit points you to this setting.</p>
|
|
5207
|
+
<h3 id="long_paths"><code>:long_paths</code></h3>
|
|
5208
|
+
<p>Reports paths against the long path limit. The first time a build path nears
|
|
5209
|
+
260 characters, Ceedling checks once whether Ceedling’s runtime can really work
|
|
5210
|
+
past that limit. It writes, reads, and lists a file in a directory nested past
|
|
5211
|
+
260 characters below your build root, then removes it.</p>
|
|
5212
|
+
<p>Outcomes:</p>
|
|
5213
|
+
<ul>
|
|
5214
|
+
<li><strong>Ruby can write and list long paths:</strong> Ceedling stays quiet about lengths up
|
|
5215
|
+
to 32,767 characters.</li>
|
|
5216
|
+
<li><strong>Ruby can write long paths but can't list them:</strong> Ceedling keeps the long
|
|
5217
|
+
limit and warns once (see <a href="#ruby-before-40">Ruby before 4.0</a>).</li>
|
|
5218
|
+
<li><strong>Long paths do not work:</strong> Ceedling warns once, naming the cause (below)
|
|
5219
|
+
and then reports against the classic limits thereafter.</li>
|
|
5220
|
+
<li>The host may not have long paths enabled.</li>
|
|
5221
|
+
<li>The application runtime may not be long-path-aware.</li>
|
|
5222
|
+
<li>The build directory’s drive may not support long paths.</li>
|
|
5223
|
+
</ul>
|
|
5224
|
+
<p>To name the cause, Ceedling reads the host’s registry setting with the
|
|
5225
|
+
<a href="tools.html#windows_registry_query"><code>:windows_registry_query</code></a> tool.</p>
|
|
5226
|
+
<h3 id="auto"><code>:auto</code></h3>
|
|
5227
|
+
<p>Runs the same check as <code>:long_paths</code>, but lifts the limit only when Ruby can
|
|
5228
|
+
both write and list long paths. Otherwise Ceedling keeps the classic limits and
|
|
5229
|
+
says why once, in a notice.</p>
|
|
5230
|
+
<h3 id="ruby-before-40">Ruby before 4.0</h3>
|
|
5231
|
+
<p>Builds of Ruby 3.x are generally long-path-aware for files. They create, read,
|
|
5232
|
+
and write files past 260 characters when long paths are enabled. But, they
|
|
5233
|
+
cannot list a directory that deep. Globs, directory listings, and recursive
|
|
5234
|
+
copies and removals fail there, or silently leave entries out. Ruby 4.0 lists
|
|
5235
|
+
them.</p>
|
|
5236
|
+
<p>On Ruby 3.x, a build directory past 260 characters can make Ceedling’s own
|
|
5237
|
+
directory scans fail. <code>clean</code> and <code>clobber</code> can leave such a directory behind.
|
|
5238
|
+
Delete it by hand, for example with <code>rmdir /s /q build</code> in a Windows shell, or
|
|
5239
|
+
use Ruby 4.0. With <code>:auto</code>, Ceedling keeps the classic limits on Ruby 3.x, so
|
|
5240
|
+
its messages still point at every path past 260 characters.</p>
|
|
5241
|
+
<h3 id="checking-your-toolchain">Checking your toolchain</h3>
|
|
5242
|
+
<p>Your compiler, linker, and other tools have path limits of their own, and
|
|
5243
|
+
Ceedling doesn‘t test them. To check a tool, create a directory more than 260
|
|
5244
|
+
characters deep, then compile and link a trivial C file there with your
|
|
5245
|
+
project’s own tools.</p>
|
|
5246
|
+
<p><strong>Default</strong>: <code>:classic</code></p>
|
|
4995
5247
|
<p><br/><br/></p>
|
|
4996
5248
|
|
|
4997
5249
|
|
|
@@ -5063,7 +5315,7 @@ build. To restore <code>:gdb</code> backtraces, re-codesign <code>gdb</code> fol
|
|
|
5063
5315
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
5064
5316
|
|
|
5065
5317
|
|
|
5066
|
-
<script src="../../assets/javascripts/bundle.
|
|
5318
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
5067
5319
|
|
|
5068
5320
|
|
|
5069
5321
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4444,6 +4444,8 @@ precedence.</p>
|
|
|
4444
4444
|
<em><build path>/artifacts/release/</em>. Ceedling sets the default artifact
|
|
4445
4445
|
file extension to that as is explicitly specified in the <code>:extension</code>
|
|
4446
4446
|
section or as is system specific otherwise.</p>
|
|
4447
|
+
<p>An absolute path, or one beginning with <code>~</code>, names the release itself. Its
|
|
4448
|
+
map file sits beside it.</p>
|
|
4447
4449
|
<p><strong>Default</strong>: <code>project.exe</code> or <code>project.out</code></p>
|
|
4448
4450
|
<h2 id="use_assembly"><code>:use_assembly</code></h2>
|
|
4449
4451
|
<p>This option causes Ceedling to enable an assembler tool and add any
|
|
@@ -4538,7 +4540,7 @@ is available in artifact paths.</p>
|
|
|
4538
4540
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4539
4541
|
|
|
4540
4542
|
|
|
4541
|
-
<script src="../../assets/javascripts/bundle.
|
|
4543
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4542
4544
|
|
|
4543
4545
|
|
|
4544
4546
|
</body>
|