Skip to content

Commit

Permalink
cmake: modules: dts: fix in/out docs
Browse files Browse the repository at this point in the history
The input/output documentation of dts.cmake and pre_dt.cmake was
outdated.

Signed-off-by: Florian Grandel <fgrandel@code-for-humans.de>
  • Loading branch information
fg-cfh authored and fabiobaltieri committed Oct 3, 2024
1 parent 80e629c commit 5688a95
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 8 additions & 0 deletions cmake/modules/dts.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,21 @@ find_package(Dtc 1.4.6)
#
# Required variables:
# - BINARY_DIR_INCLUDE_GENERATED: where to put generated include files
# - DTS_ROOT: a deduplicated list of places where devicetree
# implementation files (like bindings, vendor prefixes, etc.) are
# found
# - DTS_ROOT_SYSTEM_INCLUDE_DIRS: set to "PATH1 PATH2 ...",
# with one path per potential location where C preprocessor #includes
# may be found for devicetree files
# - KCONFIG_BINARY_DIR: where to put generated Kconfig files
#
# Optional variables:
# - BOARD: board name to use when looking for DTS_SOURCE
# - BOARD_DIR: board directory to use when looking for DTS_SOURCE
# - BOARD_REVISION_STRING: used when looking for a board revision's
# devicetree overlay file in BOARD_DIR
# - CMAKE_DTS_PREPROCESSOR: the path to the preprocessor to use
# for devicetree files
# - DTC_OVERLAY_FILE: list of devicetree overlay files which will be
# used to modify or extend the base devicetree.
# - EXTRA_DTC_OVERLAY_FILE: list of extra devicetree overlay files.
Expand Down
2 changes: 0 additions & 2 deletions cmake/modules/pre_dt.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ include(extensions)
# Outcome:
# The following variables will be defined when this CMake module completes:
#
# - CMAKE_DTS_PREPROCESSOR: the path to the preprocessor to use
# for devicetree files
# - DTS_ROOT: a deduplicated list of places where devicetree
# implementation files (like bindings, vendor prefixes, etc.) are
# found
Expand Down

0 comments on commit 5688a95

Please sign in to comment.