[PATCH] ui-commit: display commit notes as 'raw'

[PATCH] ui-commit: display commit notes as 'raw'

[stefan.naewe]

When the git function format_display_notes() is called
with a value != 0 as the last argument ('raw') the notes text
gets displayed w/o an additional 'Notes:' header. This seems
to be better suited for our needs since we're already displaying
a similar header.

Signed-off-by: Stefan Naewe <stefan.naewe at gmail.com>
---
 ui-commit.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ui-commit.c b/ui-commit.c
index d5a888d..4b40133 100644
--- a/ui-commit.c
+++ b/ui-commit.c
@@ -37,7 +37,7 @@ void cgit_print_commit(char *hex, const char *prefix)
 	}
 	info = cgit_parse_commit(commit);
 
-	format_display_notes(sha1, &notes, PAGE_ENCODING, 0);
+	format_display_notes(sha1, &notes, PAGE_ENCODING, 1);
 
 	load_ref_decorations(DECORATE_FULL_REFS);
 
-- 
2.3.3

[PATCH] ui-commit: display commit notes as 'raw'

[john]

On Fri, Mar 20, 2015 at 05:39:53PM +0100, Stefan Naewe wrote:
> When the git function format_display_notes() is called
> with a value != 0 as the last argument ('raw') the notes text
> gets displayed w/o an additional 'Notes:' header. This seems
> to be better suited for our needs since we're already displaying
> a similar header.

What happens when there are multiple display notes refs?  It seems that
without "raw", format_note() puts the name of the ref in the header it
prints (if it's not the default notes ref).

It's possible that the correct answer is that we don't care about that
case, but it is potentially a regression for people who want to display
multiple notes.

> Signed-off-by: Stefan Naewe <stefan.naewe at gmail.com>
> ---
>  ui-commit.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/ui-commit.c b/ui-commit.c
> index d5a888d..4b40133 100644
> --- a/ui-commit.c
> +++ b/ui-commit.c
> @@ -37,7 +37,7 @@ void cgit_print_commit(char *hex, const char *prefix)
>  	}
>  	info = cgit_parse_commit(commit);
>  
> -	format_display_notes(sha1, &notes, PAGE_ENCODING, 0);
> +	format_display_notes(sha1, &notes, PAGE_ENCODING, 1);
>  
>  	load_ref_decorations(DECORATE_FULL_REFS);
>  

[PATCH] ui-commit: display commit notes as 'raw'

[stefan.naewe]

On Fri, Mar 20, 2015 at 10:29 PM, John Keeping <john at keeping.me.uk> wrote:
> On Fri, Mar 20, 2015 at 05:39:53PM +0100, Stefan Naewe wrote:
>> When the git function format_display_notes() is called
>> with a value != 0 as the last argument ('raw') the notes text
>> gets displayed w/o an additional 'Notes:' header. This seems
>> to be better suited for our needs since we're already displaying
>> a similar header.
>
> What happens when there are multiple display notes refs?  It seems that
> without "raw", format_note() puts the name of the ref in the header it
> prints (if it's not the default notes ref).
That's true for 'git show --notes=...' for example.

But how would you specify the name of the notes ref in cgit ?

> It's possible that the correct answer is that we don't care about that
> case, but it is potentially a regression for people who want to display
> multiple notes.

Attached are two screenshots of commit notes added with 'git notes
add..' for the first line and
'git notes append...' for the second line. That particular commit also
has another note
attached in the 'refs/notes/todo' namespace.

My opinion about this topic: I really like the way cgit displays the
commit notes but not the
double "Notes" header line.

Regards,
   Stefan
-- 
----------------------------------------------------------------
python -c "print '73746566616e2e6e6165776540676d61696c2e636f6d'.decode('hex')"
-------------- next part --------------
A non-text attachment was scrubbed...
Name: shot-cgit-notes.png
Type: image/png
Size: 11634 bytes
Desc: not available
URL: <http://lists.zx2c4.com/pipermail/cgit/attachments/20150321/f8ffeca9/attachment.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: shot-cgit-notes-raw.png
Type: image/png
Size: 7481 bytes
Desc: not available
URL: <http://lists.zx2c4.com/pipermail/cgit/attachments/20150321/f8ffeca9/attachment-0001.png>

[PATCH] ui-commit: display commit notes as 'raw'

[john]

On Sat, Mar 21, 2015 at 02:11:51PM +0100, Stefan Naewe wrote:
> On Fri, Mar 20, 2015 at 10:29 PM, John Keeping <john at keeping.me.uk> wrote:
> > On Fri, Mar 20, 2015 at 05:39:53PM +0100, Stefan Naewe wrote:
> >> When the git function format_display_notes() is called
> >> with a value != 0 as the last argument ('raw') the notes text
> >> gets displayed w/o an additional 'Notes:' header. This seems
> >> to be better suited for our needs since we're already displaying
> >> a similar header.
> >
> > What happens when there are multiple display notes refs?  It seems that
> > without "raw", format_note() puts the name of the ref in the header it
> > prints (if it's not the default notes ref).
> That's true for 'git show --notes=...' for example.
> 
> But how would you specify the name of the notes ref in cgit ?

git config --add notes.displayRef ...

> > It's possible that the correct answer is that we don't care about that
> > case, but it is potentially a regression for people who want to display
> > multiple notes.
> 
> Attached are two screenshots of commit notes added with 'git notes
> add..' for the first line and
> 'git notes append...' for the second line. That particular commit also
> has another note
> attached in the 'refs/notes/todo' namespace.
> 
> My opinion about this topic: I really like the way cgit displays the
> commit notes but not the
> double "Notes" header line.

[PATCH] ui-commit: display commit notes as 'raw'

[stefan.naewe]

On Sat, Mar 21, 2015 at 2:19 PM, John Keeping <john at keeping.me.uk> wrote:
> On Sat, Mar 21, 2015 at 02:11:51PM +0100, Stefan Naewe wrote:
>> On Fri, Mar 20, 2015 at 10:29 PM, John Keeping <john at keeping.me.uk> wrote:
>> > On Fri, Mar 20, 2015 at 05:39:53PM +0100, Stefan Naewe wrote:
>> >> When the git function format_display_notes() is called
>> >> with a value != 0 as the last argument ('raw') the notes text
>> >> gets displayed w/o an additional 'Notes:' header. This seems
>> >> to be better suited for our needs since we're already displaying
>> >> a similar header.
>> >
>> > What happens when there are multiple display notes refs?  It seems that
>> > without "raw", format_note() puts the name of the ref in the header it
>> > prints (if it's not the default notes ref).
>> That's true for 'git show --notes=...' for example.
>>
>> But how would you specify the name of the notes ref in cgit ?
>
> git config --add notes.displayRef ...

Thanks. That looks like attached. One without and one with my patch.

Maybe we should drop the "Notes" headline that cgit generates, instead ?

Stefan
-- 
----------------------------------------------------------------
python -c "print '73746566616e2e6e6165776540676d61696c2e636f6d'.decode('hex')"
-------------- next part --------------
A non-text attachment was scrubbed...
Name: shot-cgit-notes-2refs.png
Type: image/png
Size: 10328 bytes
Desc: not available
URL: <http://lists.zx2c4.com/pipermail/cgit/attachments/20150321/345b5498/attachment.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: shot-cgit-notes-2refs-raw.png
Type: image/png
Size: 6340 bytes
Desc: not available
URL: <http://lists.zx2c4.com/pipermail/cgit/attachments/20150321/345b5498/attachment-0001.png>