Thanks for the review, Brian. I will update the manpage today.
Jedy
On Mon, 2009-01-05 at 10:14 -0600, Brian Cameron wrote:
> Jedy:
>
> > The patch will go into both the trunk and gnome224 branch.
>
> A few comments:
>
> 1) Normally we put http URL's for external documentation in the
> "SEE ALSO" section. Refer to the libpurple.3 or
> libgtk-vnc-1.0 manpage for reference. I'd move the link from
> DESCRIPTION to SEE ALSO.
>
> 2) For modules which use pkg-config, we normally do not mention
> include files in the "FILES" section. If you grep our section 3
> manpages you'll find that almost none of them reference include
> files (except for jpeg, png, tiff which the desktop team doesn't
> really own to begin with - the desktop team just ships these
> manpages).
>
> To be honest, I am not sure if this is correct. Perhaps we should
> be specifying include directories, and/or perhaps we should be
> mentioning the pkg-config file locations in the FILES section.
>
> At any rate, we should probably be consistent. I'd remove this for
> now, and we should make a decision later about whether our section
> 3 manpages should reference include and/or pkg-config file locations
> and update all the manpages so they have the same amount of
> information.
>
> Brian
>
>
> > ------------------------------------------------------>8------------
> >
> >
> > C Library Functions libical(3)
> >
> >
> >
> > NAME
> > libical - iCalendar protocol library
> >
> > DESCRIPTION
> > Implementation of the IETF's iCalendar Calendaring and
> > Scheduling protocols.
> >
> > You can find the online document at
> > http://libical.sourcearchive.com/documentation/0.33/.
> >
> > FILES
> > The following files are used by this application:
> >
> > /usr/lib/libical.so
> >
> > iCalendar shared library
> >
> >
> >
> > /usr/include/libical/*
> >
> > Development header files.
> >
> >
> >
> > ATTRIBUTES
> > See attributes(5) for descriptions of the following attri-
> > butes:
> >
> > ____________________________________________________________
> > | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
> > |_____________________________|_____________________________|
> > | Availability | SUNWlibical |
> > |_____________________________|_____________________________|
> > | Interface stability | Volatile |
> > |_____________________________|_____________________________|
> >
> >
> > SEE ALSO
> > attributes(5), gnome-interfaces(5)
> >
> > NOTES
> > Written by Jedy Wang, Sun Microsystems Inc., 2004, 2009.
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> > SunOS 5.11 Last change: 5 Jan 2009 1
> >
> >
> >
> >
>
