Bug 670934
| Summary: | etckeeper needs a README.Fedora explaining steps to get running | ||
|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Martin Langhoff <martin> |
| Component: | etckeeper | Assignee: | Thomas Moschny <thomas.moschny> |
| Status: | CLOSED ERRATA | QA Contact: | Fedora Extras Quality Assurance <extras-qa> |
| Severity: | medium | Docs Contact: | |
| Priority: | low | ||
| Version: | 14 | CC: | thomas.moschny |
| Target Milestone: | --- | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | etckeeper-0.52-1.el6 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2011-02-27 04:51:59 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Martin Langhoff
2011-01-19 17:17:58 UTC
(In reply to comment #0) > - etckeeper does not operate right after installation That's on purpose. I am pretty sure people would complain if it did touch /etc automatically. Also, people might choose to use another VCS. > - it is not clear what steps are needed -- to get it running, it has a cronjob > but the cronjob will not auto-commit anything until certain steps are performed > - the included upstream README is generic, and does not indicate what a Fedora > admin should do The README is generic, agreed, but how's that a problem? The steps described there work perfectly. > As far as I can see, the minimum steps required are, as root > > - cd /etc > - etckeeper init > - git commit -m 'somemessage' ... which is exactly what is described in the README, section ##tutorial. So, what should I put in a README.Fedora that's not already in the generic README? The README discusses various things, including the cronjob. The tutorial section is just a tutorial, and covers various other actions; does not focus on "steps needed before this all works automatically". In fact, an informed reader could conclude that etckeeper init is all that's needed. To get a clear picture of what was setup, and what was needed, I had to, in addition to reading the README... - check rpm -ql etckeeper (yes, the cronjob has been installed and makes sense) - try the cronjob until it worked -- this is how I discovered I needed an initial commit I suggest a README.Fedora saying - Read the tutorial so you understand the security aspects, and how it works - Run etckeeper init && git commit -m 'msg' to get etckeeper started - Once you do that, the cronjob is in place and it'll autocommit for you. Disable in /etc/etckeeper/etckeeper.conf etckeeper-0.52-1.fc13 has been submitted as an update for Fedora 13. https://admin.fedoraproject.org/updates/etckeeper-0.52-1.fc13 etckeeper-0.52-1.el6 has been submitted as an update for Fedora EPEL 6. https://admin.fedoraproject.org/updates/etckeeper-0.52-1.el6 etckeeper-0.52-1.fc14 has been submitted as an update for Fedora 14. https://admin.fedoraproject.org/updates/etckeeper-0.52-1.fc14 etckeeper-0.52-1.el5 has been submitted as an update for Fedora EPEL 5. https://admin.fedoraproject.org/updates/etckeeper-0.52-1.el5 etckeeper-0.52-1.el5 has been pushed to the Fedora EPEL 5 testing repository. If problems still persist, please make note of it in this bug report. If you want to test the update, you can install it with su -c 'yum --enablerepo=updates-testing update etckeeper'. You can provide feedback for this update here: https://admin.fedoraproject.org/updates/etckeeper-0.52-1.el5 etckeeper-0.52-1.fc13 has been pushed to the Fedora 13 stable repository. If problems still persist, please make note of it in this bug report. etckeeper-0.52-1.fc14 has been pushed to the Fedora 14 stable repository. If problems still persist, please make note of it in this bug report. etckeeper-0.52-1.el5 has been pushed to the Fedora EPEL 5 stable repository. If problems still persist, please make note of it in this bug report. etckeeper-0.52-1.el6 has been pushed to the Fedora EPEL 6 stable repository. If problems still persist, please make note of it in this bug report. |