]> git.ipfire.org Git - thirdparty/git.git/commit
string-list: document iterator behavior on NULL input
authorDerrick Stolee <derrickstolee@github.com>
Tue, 27 Sep 2022 13:57:01 +0000 (13:57 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 27 Sep 2022 16:32:26 +0000 (09:32 -0700)
commitd151f0cce7fca1fc156a9ea1dc98c59e1be512c9
tree2c238bf0c5686833843318f3fcc781b264aaf066
parent50a044f1e407ef217cb5d057af08e9e87daddc78
string-list: document iterator behavior on NULL input

The for_each_string_list_item() macro takes a string_list and
automatically constructs a for loop to iterate over its contents. This
macro will segfault if the list is non-NULL.

We cannot change the macro to be careful around NULL values because
there are many callers that use the address of a local variable, which
will never be NULL and will cause compile errors with -Werror=address.

For now, leave a documentation comment to try to avoid mistakes in the
future where a caller does not check for a NULL list.

Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
string-list.h