diff options
Diffstat (limited to 'docs/checks/README-function-args-by-value.md')
-rw-r--r-- | docs/checks/README-function-args-by-value.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/checks/README-function-args-by-value.md b/docs/checks/README-function-args-by-value.md new file mode 100644 index 00000000..1e96e4ae --- /dev/null +++ b/docs/checks/README-function-args-by-value.md @@ -0,0 +1,10 @@ +# function-args-by-value + +Warns when you should be passing by value instead of by-ref. +Types with sizeof <= 16 bytes [1] which are trivially-copyable [2] and trivially-destructible [3] should be passed by value. + +Only fix these warnings if you're sure that the value would be passed in a CPU register instead on the stack. + +- [1] <http://www.macieira.org/blog/2012/02/the-value-of-passing-by-value/> +- [2] <http://en.cppreference.com/w/cpp/concept/TriviallyCopyable> +- [3] <http://www.cplusplus.com/reference/type_traits/is_trivially_destructible/> |