Jerry: > Attached is the manpage modified based on Brian's valuable inputs. > Please review again.
Overall looks good, some comments: > libpisock, libpisync - C interface for communicating with a > PalmOS device Now that this is talking about two libraries, probably should say "C interfaces" rather than the singular "interface". > libpisock and libpisync are two core pilot-link libraries I'd add a period to the end of the sentence. > access to those functions. gpilotd-control-applet is one This should be gpilotd-control-applet(1). In other words add the (1). This should be done using <citerefentry><refentrytitle> format used in the "SEE ALSO" section not just by coding "(1)" in the manpage. You should remove libpisync(3) from the "SEE ALSO" section. You do not refer to manpages that are documented in the same page. Since this is now a shadow page for both libpisock and libpisync, this doesn't need to be listed here. Are there no API docs online for these interfaces? I'd add links to any API documentation in the SEE ALSO section. Brian > Brian Cameron wrote: >> >> Jerry: >> >>> These 2 libs are delivered with SUNWpilot-link, they are missing >>> manpages originally. please note libpisync is a shadow manpage. >>> Please review. >> >> Looks good. Minor comments: >> >> > in a library, which other applications can link to and gain >> >> Remove the comma. >> >> > gnome-pilot is one example of an >> > application that does exactly this. >> >> We don't ship an application called gnome-pilot. Perhaps you should >> refer to the actual application name? > Change gnome-pilot to gpilotd-control-applet. >> >> Aren't there other pilot apps which should be referenced in SEE ALSO >> such as gpilot-install-file.1, gpilotd.1, libgpilotd.3, libpilotdcm.3, >> libgpilotconduit.3. Also these manpages should probably reference >> this manpage in their "SEE ALSO" section. >> >> Brian >
