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 (<meta http-equiv="content-type" content="text/html; charset=utf-8"><a href="http://library.gnome.org/users/palimpsest/stable/advanced.html.en">http://library.gnome.org/users/palimpsest/stable/advanced.html.en</a>) 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.<div>
<br></div><div>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.</div>
<div><br></div><div>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. :)</div>
<div><br></div><div>-Vincent<br><br><div class="gmail_quote">On Wed, Nov 24, 2010 at 3:56 AM, Michael Biebl <span dir="ltr"><<a href="mailto:biebl@debian.org">biebl@debian.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div class="im">On 24.11.2010 11:32, Vincent Cheng wrote:<br>
> Package: gnome-disk-utility<br>
> Version: 2.30.1-2<br>
> Severity: normal<br>
> File: /usr/bin/palimpsest<br>
><br>
> 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.<br>
><br>
<br>
</div>Hi Vincent,<br>
<br>
thanks for your contribution.<br>
Such patches should best be sent upstream directly, so I'm bringing David into<br>
the loop here.<br>
<br>
But tbh, I think integrating a proper help system (based on yelp) would be much<br>
more valuable to our users as you can e.g. include graphics/screenshots and it<br>
is directly accessible from within the gui.<br>
See [1] for more details if you are interested in working on this.<br>
<br>
The man page itself has a few formatting errors (e.g. ..TH, should be .TH) and<br>
is very short. It doesn't really offer more information than the package<br>
description and the output of palimpsest --help. To be really useful you should<br>
explain e.g. the command line args in more detail, provide an EXAMPLE section etc.<br>
<br>
Cheers,<br>
Michael<br>
<br>
<br>
[1] <a href="http://library.gnome.org/admin/system-admin-guide/stable/help-0.html.en" target="_blank">http://library.gnome.org/admin/system-admin-guide/stable/help-0.html.en</a><br>
<font color="#888888"><br>
--<br>
Why is it that all of the instruments seeking intelligent life in the<br>
universe are pointed away from Earth?<br>
</font></blockquote></div><br></div>