Re: Adding module descriptions

[Shaun McCance <shaunm gnome org>]

On Thu, 2009-04-16 at 16:58 -0400, Owen Taylor wrote:
> The great migration to git.gnome.org is now underway. Once your module
> shows up on http://git.gnome.org/cgit/, you'll notice that it is
> described as:
> 
>  Unnamed repository; edit this file to name it for gitweb.
> 
> Since you want something better than that, what you are going to do to
> fix is add a file in the toplevel of your module named:
> 
>  <modulename>.doap
> 
> Which is a DOAP file (in RDF/XML) for your module. As an example, for
> the pango module, the file would be called 'pango.doap'. A DOAP file is
> a "description of a project" file, and allows listing all sorts of
> things about your module in machine-readable form. We'll likely use more
> from it in the future, but for now the only thing that matters is the
> 'shortdesc', which should be a phrase like:
> 
>  Internationalized text layout and rendering library
>  
> (No leading 'A' or 'The', no trailing period)
> 
> Thanks to Shaun McCance there's no need to worry about how to create a
> DOAP file, just find your module in:
> 
>  http://www.gnome.org/~shaunm/pulse/web/
> 
> And select the "Download DOAP template file" link to get a DOAP file for
> your module that you can then edit as necessary. It might even already
> have a good shortdesc if Pulse could find one from your .desktop file.

Hubert Figuiere just pointed out a limitation of having
Pulse provide these: Pulse doesn't track everything in
our repositories.  For those whose modules aren't being
tracked in Pulse, here's the DOAP template that Pulse
created for pango:

http://www.gnome.org/~shaunm/pango.doap

Putting in the information for your module should be
pretty straightforward.

For everybody else, if you don't feel like clicking
around, the URL for your module is

http://www.gnome.org/~shaunm/pulse/web/mod/svn.gnome.org/<module>/trunk

Replace <module> with the module name.

(Yes, it's still from SVN.  It'll take me a couple of
days to reseed Pulse against our Git repositories.)

--
Shaun