Re: [PATCH 3/4] Documentation/notes: describe content of notes

[Jeff King <peff@peff.net>]

On Tue, May 04, 2010 at 11:55:01AM +0200, Johan Herland wrote:

> On Tuesday 04 May 2010, Jonathan Nieder wrote:
> > Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
> > ---
> >  Documentation/git-notes.txt |    4 ++++
> >  1 files changed, 4 insertions(+), 0 deletions(-)
> > 
> > diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
> > index 0594776..273264b 100644
> > --- a/Documentation/git-notes.txt
> > +++ b/Documentation/git-notes.txt
> > @@ -27,6 +27,10 @@ By default, notes are saved to and read from
> > `refs/notes/commits`, but this default can be overridden.  See the
> > CONFIGURATION and ENVIRONMENT sections below.
> > 
> > +Notes can contain any sequence of non-null bytes.  Since they are
> > +sanitized with linkgit:git-stripspace[1], empty lines other than a
> > +single line separating paragraphs are not significant.
> 
> In principle, a note is a regular Git (blob) object, and can contain NUL 
> bytes - indeed any kind of (non-)format is accepted.
> 
> However, the stripspace/text-based formatting kicks in when specifying the 
> notes content with -m or -F, or when an editor is used to edit the notes.

The textconv-cache notes contain whatever the textconv filter produces,
so they are a likely way of getting non-standard characters. In
practice, though, you will probably not see NULL, because the point was
to generate a _text_ version.

-Peff