David:

Some comments:

In the two spec files you provide this description:

In SUNWdrivel.spec:
Summary:            Drivel - A GNOME client for offline blog

In drivel.spec:
Summary:        Drivel is a GNOME client for offline blog

What does "offline blog" mean?  Perhaps "Drivel - Blog Editor"
would be more concise and clear to use in both spec files as
the Summary.

Note in the manpage you say "online blogs", but here you say "offline".
That seems a bit confusing.

In the manpage:

   NAME
      drivel - GNOME client for working with online blogs

I would say "editing" instead of "working with".  Would
it be better to remove the word "online" and just say
"GNOME client for editing blogs"?

Note the DESCRIPTION section has similar text which should also be
updated to be similar.

   SYNOPSIS
        drivel [options ... ] [url]

We normally list the options in the SYNOPSIS so instead of
"[options ... ]" you should say "[-v]".

Also note that "[url]" is an OPERAND, so the manpage should have
an OPERAND section to explain this.  The manpage is missing this.
Is the URL operand optional?  It should only be surrounded by "["
and "]" characters if the operand is optional, by the way.

   DESCRIPTION

In this section there is the following list

      - Support for LiveJournal, Blogger,  MovableType,  Advogato,
      and Atom journals

      - The ability to post, edit, delete, and view recent entries

      [...]

Looking at the drivel.1 file you are not using <listitem> tags
to generate this list.  This makes the formatting show up wrong.
You should be using <listitem> here.  Note the "EXTENDED
DESCRIPTION" section of the create-branching-keyboard.1 manpage in
spec-files/manpages/man1 directory to see an example of how to format
a list correctly.

    SEE ALSO

You should include attributes(5) in the SEE-ALSO list.  Also if
drivel supports gnome-std-options(5), you should reference that
manpage here and in the SYNOPSIS.  Refer to any GNOME GUI manpage
(e.g. "gnome-help") for an example of how the "SEE ALSO" section
should be formatted.

Brian


> Hi JDS team,
> 
> Would you please help me to review the following packaging code for
> poring drivel into JDS gate?
> 
> You can find the spec and related files from the attachment of this
> email or accessing the following weblink:
> http://fogbroom.prc/bjroot/users/yz203490/FOSS/drivel_spec/
> 
> The human-readable manpage output is in drivel.1_man.txt, drivel.1 is
> the original xml file.
> 
> It is highly appreciate if you could give me any comments and 
> suggestions :)
> Have a nice day!
> 
> Regards,
> David
> 
> On 02/10/09 18:31, Dermot McCluskey wrote:
>> Have you sent out your code (spec-files, etc) for code-review
>> to jds-review at opensolaris.org?  If not, please do so ASAP.
>>
>> What "SUNWspec documentation" are you referring to?
>>
>> I will ask the REs doing the build if they are prepared to
>> do a partial respin for this pkg, but I am not promising
>> anything - in fact, I think it's far too late to be adding
>> brand new pkgs to the stable build.
>>
>>
>> - Dermot
>>
>>
>>
>>
>>
>> On 02/10/09 08:56, David Zhang wrote:
>>> On 02/10/09 14:28, Leo Binchy wrote:
>>>> Grant Zhang wrote:
>>>>> Hi Dermot,
>>>>>
>>>>> Yes, we are still planning to integrate into the JDS gate.
>>>>>
>>>>> Leo approved the drivel  checklist for B112 integration.  
>>>> Correction Dee approved it
>>>>> Leo, I would like to check whether it is possible for us to 
>>>>> integrate to B109, instead of B112. 
>>>> If all the QA is done - which I am assuming it is as it got approval 
>>>> there is no reason as to why this cannot go into build 109. Howvere 
>>>> it seems you have now missed build 109 as  RE kicked this build off 
>>>> yesterday.
>>> Hi Leo and Dermot,
>>>
>>> All the QA is done, I am preparing the SUNWspec documentation which I 
>>> plan to send it out today. Could we also catch up with JDS_b109 by 
>>> any chance?
>>>
>>>
>>>>> What does it entail? From code changes point of view David is ready 
>>>>> for integration. We can provide additional information if needed.
>>> Our original target was b111 which is 1 month later, however the b110 
>>> and b111 became restricted. If we get it into b112, our original 
>>> target build is /delayed/ 1 build.
>>> If we could get it into b109, that would be much better. I am getting 
>>> familiar with SUNWspec and CBE(diffs) - I am pretty new to JDS gate. 
>>> Those are the latest 2 steps, correct?
>>>
>>> Regards,
>>> David
>>>>>
>>>>> Thanks,
>>>>>
>>>>> Grant
>>>>>
>>>>> Dermot McCluskey wrote:
>>>>>> Grant/David,
>>>>>>
>>>>>> Are you still planning to integrate drivel via the
>>>>>> JDS gate?  b109 started today and I don't any sign of
>>>>>> a spec-file for drivel in the JDS code repository.
>>>>>>
>>>>>>
>>>>>> - Dermot
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> On 02/09/09 13:57, Grant Zhang wrote:
>>>>>>> Hi Dermot,
>>>>>>>
>>>>>>> Drivel was approved last week for B112 integration, since 
>>>>>>> B110/B111 are limited content builds. David Zhang is the RE for 
>>>>>>> Drivel.
>>>>>>>
>>>>>>> We are actually trying to get drivel into B109 if possible.
>>>>>>>
>>>>>>> Thanks,
>>>>>>>
>>>>>>> Grant
>>>>>>>
>>>>>>>
>>>>>>> Dermot McCluskey wrote:
>>>>>>>> Hi Grant,
>>>>>>>>
>>>>>>>> What is the status of drivel?  According to our schedule
>>>>>>>> you were planning to integrate to JDS and then integrate
>>>>>>>> to Solaris Nevada by build 111?
>>>>>>>>
>>>>>>>> Is that still the case?  If not, do you have a new schedule?
>>>>>>>>
>>>>>>>> Thanks,
>>>>>>>> - Dermot
>>>>>>>
>>>>>
>>>>
>>>
> 
> 
> 
> ------------------------------------------------------------------------
> 
> 
> 
> 
> 
> %commonents;
> 
> %booktitles;
> 
> ]>
> 
> 
> 
> 
> &cmd;1
> 12 Feb 2009
> &man1;
> &release;
> generic
> &suncopy;
> 
> 
> &cmd;GNOME client for
> working with online blogs
> 
> 
> &cmd;
> GNOME client for working with online blogs
> 
> 
> &cmd;
> options ... 
> url
> 
> 
> 
> 
> 
> &cmd; is a GNOME client for working with online blogs.
> 
> 
> - Support for LiveJournal, Blogger, MovableType, Advogato, and Atom journals
> 
> 
> - The ability to post, edit, delete, and view recent entries
> 
> 
> - Integrated spellchecking and HTML syntax highlighting
> 
> 
> - Offline composition and editing
> 
> 
> - Automatic recovery in the event of a crash
> 
> 
> - Journal system extensions, including LiveJournal and MovableType
> 
> 
> 
> 
> The following options are supported:
> 
> 
> v or verbose
> Enables debug output
> 
> 
> 
> 
> 
> 
> example% &cmd;
> 
> 
> 
> 
> The following exit values are returned:
> 
> 0Application
> exited successfully
> 
> 1Application
> exited with failure
> 
> 
> 
> 
> The following files are used by this application:
> 
> /usr/bin/&cmd; 
> Executable for Drivel application
> 
> 
> 
> 
> See 
> attributes5
> for descriptions of the following attributes:
> 
> 
> 
> 
> ATTRIBUTE TYPEATTRIBUTE VALUE
> 
> 
> AvailabilitySUNWdrivel
> 
> Interface stabilityVolatile
> 
> 
> 
> 
> 
> 
> 
> 
> For more information about drivel, please refer to
> http://dropline.net/past-projects/drivel-blog-editor
> 
> 
> 
> Drivel was written by Todd Kulesza <todd at dropline.net>. 
> This manual page was written by David Zhang <david.zhang at sun.com>.
> 
> 
> 


Reply via email to