Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 17405 - ntp ebuild doesn't install man pages and lacks documentation
Summary: ntp ebuild doesn't install man pages and lacks documentation
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: SpanKY
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 20747
  Show dependency tree
 
Reported: 2003-03-12 16:25 UTC by Per Cederberg
Modified: 2003-06-11 19:31 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Per Cederberg 2003-03-12 16:25:46 UTC
When installing ntp 4.1.1b-r5, the only documentation that is installed 
in /usr/share/doc. No man pages are installed, although the text for 
such man pages are clearly available in HTML form in the /usr/share/doc 
directory.

Also, the ntp ebuild doesn't provide very good instructions on how to 
actually install it. Is it sufficient to configure /etc/ntp.conf or 
should the /etc/conf.d/ntpd file also be edited? It might also be 
helpful to add the rc-update add ntdp default command to the message.

See the following post for some comments from a frustrated user that
attempted at getting ntp installed and configured correctly:
http://forums.gentoo.org/viewtopic.php?p=240124#240124


Reproducible: Always
Steps to Reproduce:
Comment 1 SpanKY gentoo-dev 2003-03-21 11:17:24 UTC
lack of manpage is invalid ... see Bug 13612

as for lack of proper setup docs, the pkg_postinst() takes care of that ...
i've updated it here:
http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo-x86/net-misc/ntp/ntp-4.1.1b-r5.ebuild.diff?r1=1.4&r2=1.5

if the user failed to see that msg, its a portage bug and there are bugs open to handle proper display of e* msg's ...
Comment 2 Per Cederberg 2003-03-21 11:41:56 UTC
The new messages are better, thanks. If you add the following line too,
they would be even better:

"Finally, install with 'rc-update add ntpd default'."

Sorry about rehashing the man page issue.
Comment 3 SpanKY gentoo-dev 2003-03-21 12:15:04 UTC
i wont add the rc-update thing cause that can be applied to all packages that
install an init.d script ...

basically, people should read the docs on the Gentoo page ...
http://www.gentoo.org/doc/en/rc-scripts.xml
Comment 4 Per Cederberg 2003-03-21 12:37:16 UTC
In theory I agree with you and for most packages this would be 
sufficient. It is just that some users (me included) did not 
originally understand that the ntp client is a daemon. 

We erroneously assumed that it was the ntpdate program that was 
the main event, and that it had to be crontab:ed. I though that 
the ntpd daemon was only needed to run a ntp server.

It wasn't until I actually read the docs that I understood that 
ntpd is both a client and a server in one daemon process. This 
is, in my opinion, rather odd for Unix daemons (but there are
probably good reasons for it).

So, to make my point, I still think that the rc-update should
be explicitly mentioned to make it painfully clear that this is
how ntp should be installed.

Sorry about being so verbose and persistent in this, I just 
wanted to make sure that you understood my point.

BTW. Checked up the ntp distribution site. Unbelievable that 
they do not distribute anything but HTML. Not even XML or SGML
doc sources what I could find. Really disappointing...