journal: Document generic_array_bisect()
authorDaan De Meyer <daan.j.demeyer@gmail.com>
Wed, 20 Apr 2022 21:58:39 +0000 (23:58 +0200)
committerDaan De Meyer <daan.j.demeyer@gmail.com>
Wed, 20 Apr 2022 21:58:39 +0000 (23:58 +0200)
commit9a390e86b7b60676ac6ae78224fe65b5951c0836
treef33212f7ca62e70f656ac153d6c97967f8cb4a8d
parent4d8b09e4b85611e5c5b44bee328084f825ba3a9c
journal: Document generic_array_bisect()

It's not trivial to figure out that this function does not search
for an exact match for the given needle, but whichever object in
the given direction that's closest to the needle.

Let's add a documentation blurb to explain how the function works
for to help future developers looking at this function.
src/libsystemd/sd-journal/journal-file.c