From: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
Date: Fri, 06 Feb 2009 11:01:31 GMT
Subject: Re: [PATCHv2 2/6] gitweb: feed generator metadata
Message-ID: <cb7bb73a0902060301s2a2f81e2t1762377177fb550e@mail.gmail.com>
In-Reply-To: <200902050015.20170.jnareb@gmail.com>

On Thu, Feb 5, 2009 at 12:15 AM, Jakub Narebski <jnareb@gmail.com> wrote:
> On Mon, 26 Jan 2009, Giuseppe Bilotta wrote:
>
>> Add <generator> tag to RSS and Atom feed. Versioning info (gitweb/git
>> core versions, separated by a literal slash) is stored in the
>> appropriate attribute for the Atom feed, and in the tag content for the
>> RSS feed.
>
> Very good idea. I haven't examined either specification, so I don't
> know what conventions are used, though... and what conventions _should_
> be used.
>
> By the way, gitweb uses in HTML header the following (see
> git_header_html subroutine):
>
>  <meta name="generator" content="gitweb/$version git/$git_version$mod_perl_version"/>
>
> which tries to follow convention how _web servers_ like Apache return
> version information in the 'Server:' HTTP response header (product
> tokens). Because it was used on only one place, it was not put into
> separate subroutine; should it now?

RSS 2.0 spec for generator @
http://cyber.law.harvard.edu/rss/rss.html#optionalChannelElements
seems to suggest that the content for the tag in RSS feeds is pretty
much free-form and we might use the same string we have in HTML pages.
Requirements for Atom (see
http://www.atomenabled.org/developers/syndication/atom-format-spec.php#element.generator
) are rather more stringent, so it needs its own code anyway.

>> Signed-off-by: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
>> ---
>>  gitweb/gitweb.perl |    2 ++
>>  1 files changed, 2 insertions(+), 0 deletions(-)
>>
>> diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
>> index f8a5d2e..3d94f50 100755
>> --- a/gitweb/gitweb.perl
>> +++ b/gitweb/gitweb.perl
>> @@ -6085,6 +6085,7 @@ XML
>>                             "<link>$alt_url</link>\n" .
>>                             "</image>\n";
>>               }
>> +             print "<generator>gitweb v.$version/$git_version</generator>\n";
>>       } elsif ($format eq 'atom') {
>>               print <<XML;
>>  <feed xmlns="http://www.w3.org/2005/Atom">
>> @@ -6111,6 +6112,7 @@ XML
>>               } else {
>>                       print "<updated>$latest_date{'iso-8601'}</updated>\n";
>>               }
>> +             print "<generator version='$version/$git_version'>gitweb</generator>\n";
>
> I'd rather use '"' for attributes, i.e.
>
> +               print "<generator version=\"$version/$git_version\">gitweb</generator>\n";

I can do that.

-- 
Giuseppe "Oblomov" Bilotta