Bug 1444336
| Summary: | etcd man pages missing | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | Marko Myllynen <myllynen> |
| Component: | etcd | Assignee: | Jan Chaloupka <jchaloup> |
| Status: | CLOSED ERRATA | QA Contact: | atomic-bugs <atomic-bugs> |
| Severity: | low | Docs Contact: | |
| Priority: | low | ||
| Version: | 7.3 | CC: | decarr, jchaloup, ypu |
| Target Milestone: | rc | Keywords: | Extras |
| Target Release: | --- | Flags: | ypu:
needinfo-
|
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | etcd-3.2.9-1.el7 | Doc Type: | If docs needed, set a value |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2017-11-30 18:42:50 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Marko Myllynen
2017-04-21 07:52:41 UTC
Hi Marko, that sounds good to me. Can you point me to the online man pages? So far I have not been aware of any existing man pages besides the upstream documentation. These I found with quick googling: http://manpages.org/etcd http://manpages.org/etcdctl I'm not sure where they are coming from. I couldn't find a page for etcd.conf. Thanks. Thanks. Let's see why upstream has to say about it. https://github.com/coreos/etcd/issues/7796 Reviving https://github.com/coreos/etcd/issues/7796. With some simple hacks it's quite simple to generate man pages for etcdctl command fully automatically. Can't say the same for etcd. However, once properly done, even the etcd.conf man page could be easily generated. The etcd.conf file is itself verbose enough. The etcd.conf man be added eventually. Hi Jan,
Check it with rpm -ql and the man pages are there and use man to check the context. Seems there is one little problem, the title in the corner is not correct.
Take etcdctl3-put as example. The title for it is etcdctl3 but not etcdctl3-put.
Can you help to check this?
etcdctl3(1) etcdctl3(1)
NAME
ETCDCTL=3 etcdctl-put - Puts the given key into the store
Others seems OK for me.
Discussed with Jan and report another bug for the .TH problem as it is auto generated. Other part of the man pages looks good. So set this to verified. Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHBA-2017:3361 |