sierrafoxtrot
commented
2 years ago I like the suggested format for Indentation, Closing Parens, multi-line function calls and file lists. I especially like the extra indent for values. Clearly shows a hierarchy.
# suggested:
add_custom_target(tgt
DEPENDS
file1
file2
file3
)Embarrassed to say that it had never occurred to me that a new line for each arg could help prevent merge conflicts.
Regarding the args, I don't really see the value in forcing folks to string quote them. Am I missing something?
jtxa
oceanofthelost
Discussion about possible improvements
bin/in build dir (there's a variable to control that)include_directories, usetarget_include_directoriesTooling
There is some tooling: cmake language tools interesting tools contained: lint, format
Haven't used it myself yet, don't know how widely used and mature it is. Don't know what the formatter can do.
Discussion about format
Indentation
rationale: No manual extra formatting of single spaces. Less effort to write.
closing parentheses
rationale: Better visibility where it ends. Easily insert something at the end, without extra care for parentheses.
multi-line function calls
rationale: readability, avoids merge conflicts
file lists (for multi-line function calls)
rationale: readability, avoids merge conflicts
This could also be applied to
COMMANDand others. For file lists with more than 1 file I would always do this, for other things I can't say this in general. I do an extra indent for values, don't know if the formatter can do such things.Ideas to consider when writing CMake files
Just apply if really help in readability, not in general.
strings quotation marks
rationale: readability (only with syntax coloring), easier to identify a single value
strings bracket argument
rationale: avoid extra backslashes, e.g. in RegEx drawback: inside bracket argument variables are not expanded (not relevant here)