Bug 206866
| Summary: | [handbook] Replace mergemaster(8) with newer etcupdate(8) utility for source upgrades | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Ben Woods <woodsb02> |
| Component: | Books & Articles | Assignee: | Warren Block <wblock> |
| Status: | Closed FIXED | ||
| Severity: | Affects Some People | CC: | chris, dch, des, grahamperrin, wblock, woodsb02 |
| Priority: | --- | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
| URL: | https://reviews.freebsd.org/D7665 | ||
| Attachments: | |||
|
Description
Ben Woods
2016-02-03 00:47:39 UTC
Created attachment 166466 [details]
Patch to update handbook to replace mergemaster(8) with etcupdate(8)
Created attachment 166467 [details]
QA: Successully built makeworld.html section from handbook (with proposed changes)
Requires docbook.css to be in same folder for correct styling.
> Modified to use the newer etcupdate(8) utility by Ben Woods. It doesn't *use* anything. It *describes* etcupdate(8). > Note that etcupdate has replaced mergemaster(8) [...] as the latter > required the user to review all of the differences [...] That's not true. With the correct configuration, mergemaster(8) is just as easy to use as etcupdate(8) in most cases. The main (user-visible) difference is that etcupdate(8) does three-way merges, which make conflict resolution much easier. > If it shows an unexpected result, or if it fails with an error about > a missing reference tree, then it is likely that etcupdate needs to > be bootstrapped. It only needs to be bootstrapped if it says it hasn't been already. If it shows an "unexpected result" that isn't an error, then you've either bootstrapped it from a source tree that doesn't match your running system or simply not run it after your last update. > svn checkout -r YOURREVISION https://svn.FreeBSD.org/base/head/ > /PATH/TO/SAVE/SOURCE/TREE Since you're building from source, it's reasonable to assume that you already have a working copy. In that case, it is faster to revert it to the correct version than to check out a new copy. Also, svn:// is faster than https://, and don't assume that people are running head. > Before using etcupdate, it is recommended to have a backup or > snapshot of /etc. It's probably not a bad idea, but I'm uncomfortable with actually recommending it. It gives the reader the impression that etcupdate is unreliable. Finally, and most importantly, you don't describe how to resolve conflicts ('etcupdate merge'). > > Note that etcupdate has replaced mergemaster(8) [...] as the > > latter required the user to review all of the differences [...] > That's not true. [...] I left out my main point here, which is that it is completely unnecessary, in my opinion, to explain *why* mergemaster(8) is being replaced. > Finally, and most importantly, you don't describe how to resolve > conflicts ('etcupdate merge'). Sorry, 'etcupdate resolve' of course. Created attachment 166719 [details]
Patch to update handbook to replace mergemaster(8) with etcupdate(8)
Thanks for looking at this patch DES, and for providing feedback. I have updated my patch (attached) and believe I have addressed each of your comments. Please let me know if you have any further comments.
Created attachment 166720 [details]
QA: Successully built makeworld.html section from handbook (with proposed changes)
Hi DES, I'm hoping to get this committed into the handbook, and I'm open to making changes if it's not quite right. Would you mind taking another look and let me know if you have any comments? Thanks, Ben Comment on attachment 166719 [details] Patch to update handbook to replace mergemaster(8) with etcupdate(8) Warren Block has proposed a complete overhaul of the "updating from source" section of the handbook, which simplifies the chapter significantly and includes details of etcupdate(8). https://reviews.freebsd.org/D7665 Suggest Warren's work is more applicable than this patch, and therefore marking this patch as obsolete. People can still refer back to this patch for wording if needed for the updated chapter. batch change: For bugs that match the following - Status Is In progress AND - Untouched since 2018-01-01. AND - Affects Base System OR Documentation DO: Reset to open status. Note: I did a quick pass but if you are getting this email it might be worthwhile to double check to see if this bug ought to be closed. <https://docs.freebsd.org/en/books/handbook/cutting-edge/#updating-src-quick-start> exemplifies use of etcupdate(8). <https://cgit.freebsd.org/doc/log/documentation/content/en/books/handbook?qt=grep&q=etcupdate finds two 2021 commits. See also: bug 260253 The FreeBSD handbook "Updating FreeBSD from Source" section was updated to prefer etcupdate in May 2017 with svn commit r50251. https://reviews.freebsd.org/rD50251 https://cgit.freebsd.org/doc/commit/?id=a7640c82441bdf19f738af7d3b144b011750e0be |