averello/git-mirror
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2025-12-12 20:36:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

trailer: teach iterator about non-trailer lines

Browse Source 
Previously the iterator did not iterate over non-trailer lines. This was
somewhat unfortunate, because trailer blocks could have non-trailer
lines in them since 146245063e (trailer: allow non-trailers in trailer
block, 2016-10-21), which was before the iterator was created in
f0939a0eb1 (trailer: add interface for iterating over commit trailers,
2020-09-27).

So if trailer API users wanted to iterate over all lines in a trailer
block (including non-trailer lines), they could not use the iterator and
were forced to use the lower-level trailer_info struct directly (which
provides a raw string array that includes all lines in the trailer
block).

Change the iterator's behavior so that we also iterate over non-trailer
lines, instead of skipping over them. The new "raw" member of the
iterator allows API users to access previously inaccessible non-trailer
lines. Reword the variable "trailer" to just "line" because this
variable can now hold both trailer lines _and_ non-trailer lines.

The new "raw" member is important because anyone currently not using the
iterator is using trailer_info's raw string array directly to access
lines to check what the combined key + value looks like. If we didn't
provide a "raw" member here, iterator users would have to re-construct
the unparsed line by concatenating the key and value back together again

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Linus Arver
2024-05-02 04:54:20 +00:00
committed by Junio C Hamano
parent 56b04883f0
commit 3be65e6ee2
3 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
trailer.h
View File

@@ -125,6 +125,13 @@ void format_trailers_from_commit(const struct process_trailer_options *,
* trailer_iterator_release(&iter);
*/
struct trailer_iterator {
/*
* Raw line (e.g., "foo: bar baz") before being parsed as a trailer
* key/val pair as part of a trailer block (as the "key" and "val"
* fields below). If a line fails to parse as a trailer, then the "key"
* will be the entire line and "val" will be the empty string.
*/
const char *raw;
struct strbuf key;
struct strbuf val;