Skip to content

makefiles/dependencies_debug.inc.mk: add DEPENDENCY_DEBUG_SORT_VARS#13222

Merged
aabadie merged 1 commit intoRIOT-OS:masterfrom
fjmolinas:pr_deps_sort
Jan 28, 2020
Merged

makefiles/dependencies_debug.inc.mk: add DEPENDENCY_DEBUG_SORT_VARS#13222
aabadie merged 1 commit intoRIOT-OS:masterfrom
fjmolinas:pr_deps_sort

Conversation

@fjmolinas
Copy link
Contributor

Contribution description

Define DEPENDENCY_DEBUG_SORT_VARS that can be set as 1 so that
DEPS_DEBUG_VARS are sorted before saving to file.

I'm not sure why @cladmi only sorted FEATURES_REQUIRED and FEATURES_PROVIDED. As far what I can tell, sorting hides a lot of debug information on the order the variable was added and by whom. For this reason I leave the option as disabled by default. But being able to set this can reduce the noise significantly when comparing the dependencies for the whole tree, e.g. as was done in #12898.

Testing procedure

  • BOARD=pic32-clicker make dependency-debug -C examples/hello-world/
BOARD = pic32-clicker
CPU = mips_pic32mx
CPU_MODEL = p32mx470f512h
CPU_FAM =
FEATURES_PROVIDED = periph_gpio periph_timer periph_uart periph_cpuid arch_32bit arch_mips32r2 cpp periph_pm
_FEATURES_PROVIDED_SORTED = arch_32bit arch_mips32r2 cpp periph_cpuid periph_gpio periph_pm periph_timer periph_uart
FEATURES_REQUIRED = periph_uart arch_32bit arch_mips32r2 periph_uart arch_32bit arch_mips32r2
_FEATURES_REQUIRED_SORTED = arch_32bit arch_mips32r2 periph_uart
FEATURES_OPTIONAL = periph_gpio periph_pm periph_gpio periph_pm
FEATURES_USED = arch_32bit arch_mips32r2 periph_gpio periph_pm periph_uart
FEATURES_MISSING =
FEATURES_CONFLICT =
FEATURES_CONFLICTING =
USEMODULE = auto_init board core core_msg cpu mips32r2_common mips32r2_common_periph mips_pic32_common mips_pic32_common_periph newlib newlib_syscalls_mips_uhi periph_common periph_gpio periph_pm periph_timer periph_uart stdio_uart sys
DEFAULT_MODULE = board cpu core core_msg sys auto_init
DISABLE_MODULE = stdio_rtt stdio_rtt
  • DEPENDENCY_DEBUG_SORT_VARS=1 BOARD=pic32-clicker make dependency-debug -C examples/hello-world/
= BOARD pic32-clicker
= CPU mips_pic32mx
= CPU_MODEL p32mx470f512h
= CPU_FAM
= FEATURES_PROVIDED arch_32bit arch_mips32r2 cpp periph_cpuid periph_gpio periph_pm periph_timer periph_uart
= _FEATURES_PROVIDED_SORTED arch_32bit arch_mips32r2 cpp periph_cpuid periph_gpio periph_pm periph_timer periph_uart
= FEATURES_REQUIRED arch_32bit arch_mips32r2 periph_uart
= _FEATURES_REQUIRED_SORTED arch_32bit arch_mips32r2 periph_uart
= FEATURES_OPTIONAL periph_gpio periph_pm
= FEATURES_USED arch_32bit arch_mips32r2 periph_gpio periph_pm periph_uart
= FEATURES_MISSING
= FEATURES_CONFLICT
= FEATURES_CONFLICTING
= USEMODULE auto_init board core core_msg cpu mips32r2_common mips32r2_common_periph mips_pic32_common mips_pic32_common_periph newlib newlib_syscalls_mips_uhi periph_common periph_gpio periph_pm periph_timer periph_uart stdio_uart sys
= DEFAULT_MODULE auto_init board core core_msg cpu sys
= DISABLE_MODULE stdio_rtt

Issues/PRs references

Define DEPENDENCY_DEBUG_SORT_VARS that can be set as 1 so that
DEPS_DEBUG_VARS are sorted before saving to file.
@fjmolinas fjmolinas added Area: tools Area: Supplementary tools Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation labels Jan 28, 2020
Copy link
Contributor

@aabadie aabadie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for this change.

ACK

@aabadie aabadie added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jan 28, 2020
@fjmolinas
Copy link
Contributor Author

@cladmi does my interpretation of why you didn't sort by default match your reasoning?

@cladmi
Copy link
Contributor

cladmi commented Jan 28, 2020

@fjmolinas yes I did it to keep the duplication and declaration order as it helped notice when they were changed during a refactoring so ensured the change was reviewed.

@aabadie aabadie merged commit ac446f7 into RIOT-OS:master Jan 28, 2020
@fjmolinas fjmolinas deleted the pr_deps_sort branch January 28, 2020 13:22
@leandrolanzieri leandrolanzieri added this to the Release 2020.04 milestone Feb 20, 2020
@leandrolanzieri leandrolanzieri added the Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer label Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants