[Pkg-utopia-maintainers] Bug#604784: Bug#604784: /usr/bin/palimpsest: man page missing

[Vincent Cheng]

I've tried to search for as much documentation as I could find about
gnome-disk-utility/palimpsest, but my search has turned up rather fruitless;
Gnome's documentation is very brief (
http://library.gnome.org/users/palimpsest/stable/advanced.html.en) and the
documentation in gnome-disk-utility's source tarball is centered on the
libgdu API, not on the usage of palimpsest itself. I'm having trouble
finding a reliable source of documentation to improve upon the manual page
that I've written so far.

For the moment, I've just added a brief example section in the man page.
(I'm sorry, but I don't see "..TH" anywhere though). If/when I find
additional sources of documentation to expand upon what I've written so far,
I'll definitely have another go at this.

As for writing documentation based on Yelp, I think it would be a great idea
as well to expand on the little information available via Yelp on
palimpsest; I'll have to look into that later. At the moment, I still have a
lot to learn about writing manual pages. :)

-Vincent

On Wed, Nov 24, 2010 at 3:56 AM, Michael Biebl <biebl at debian.org> wrote:

> On 24.11.2010 11:32, Vincent Cheng wrote:
> > Package: gnome-disk-utility
> > Version: 2.30.1-2
> > Severity: normal
> > File: /usr/bin/palimpsest
> >
> > As a Debian Google Code-In student, I'd like to submit a missing manual
> page for palimpsest (attached with this bug report). Please let me know if
> you think anything needs to be changed.
> >
>
> Hi Vincent,
>
> thanks for your contribution.
> Such patches should best be sent upstream directly, so I'm bringing David
> into
> the loop here.
>
> But tbh, I think integrating a proper help system (based on yelp) would be
> much
> more valuable to our users as you can e.g. include graphics/screenshots and
> it
> is directly accessible from within the gui.
> See [1] for more details if you are interested in working on this.
>
> The man page itself has a few formatting errors (e.g. ..TH, should be .TH)
> and
> is very short. It doesn't really offer more information than the package
> description and the output of palimpsest --help. To be really useful you
> should
> explain e.g. the command line args in more detail, provide an EXAMPLE
> section etc.
>
> Cheers,
> Michael
>
>
> [1]
> http://library.gnome.org/admin/system-admin-guide/stable/help-0.html.en
>
> --
> Why is it that all of the instruments seeking intelligent life in the
> universe are pointed away from Earth?
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.alioth.debian.org/pipermail/pkg-utopia-maintainers/attachments/20101125/55eb2316/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: palimpsest.1
Type: application/octet-stream
Size: 1075 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/pkg-utopia-maintainers/attachments/20101125/55eb2316/attachment.obj>