git/refs at a20e20e4c8fe6c13e03af8109644a84d8f4e7f7f - git

Tree: a20e20e4c8

Junio C Hamano 523fa69c36 reflog: cleanse messages in the refs.c layer Regarding reflog messages: - We expect that a reflog message consists of a single line. The file format used by the files backend may add a LF after the message as a delimiter, and output by commands like "git log -g" may complete such an incomplete line by adding a LF at the end, but philosophically, the terminating LF is not a part of the message. - We however allow callers of refs API to supply a random sequence of NUL terminated bytes. We cleanse caller-supplied message by squashing a run of whitespaces into a SP, and by trimming trailing whitespace, before storing the message. This is how we tolerate, instead of erring out, a message with LF in it (be it at the end, in the middle, or both). Currently, the cleansing of the reflog message is done by the files backend, before the log is written out. This is sufficient with the current code, as that is the only backend that writes reflogs. But new backends can be added that write reflogs, and we'd want the resulting log message we would read out of "log -g" the same no matter what backend is used, and moving the code to do so to the generic layer is a way to do so. An added benefit is that the "cleansing" function could be updated later, independent from individual backends, to e.g. allow multi-line log messages if we wanted to, and when that happens, it would help a lot to ensure we covered all bases if the cleansing function (which would be updated) is called from the generic layer. Side note: I am not interested in supporting multi-line reflog messages right at the moment (nobody is asking for it), but I envision that instead of the "squash a run of whitespaces into a SP and rtrim" cleansing, we can %urlencode problematic bytes in the message AND append a SP at the end, when a new version of Git that supports multi-line and/or verbatim reflog messages writes a reflog record. The reading side can detect the presense of SP at the end (which should have been rtrimmed out if it were written by existing versions of Git) as a signal that decoding %urlencode recovers the original reflog message. Signed-off-by: Han-Wen Nienhuys <hanwen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		5 years ago
..
files-backend.c	reflog: cleanse messages in the refs.c layer	5 years ago
iterator.c	refs.c: migrate internal ref iteration to pass thru repository argument	6 years ago
packed-backend.c	pack-refs: always refresh after taking the lock file	6 years ago
packed-backend.h	refs/packed-backend.h: add missing declaration (hdr-check)	6 years ago
ref-cache.c	convert "oidcmp() != 0" to "!oideq()"	6 years ago
ref-cache.h	refs/ref-cache.h: add missing declarations (hdr-check)	6 years ago
refs-internal.h	reflog: cleanse messages in the refs.c layer	5 years ago