Bug 260253

Summary: handbook: 24.5.1 missing warning about migrating from mergemaster to etcupdate
Product: Documentation Reporter: plastickey <yetoohappy>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Some People CC: carlavilla, grahamperrin, pauamma
Priority: --- Keywords: patch-ready
Version: Latest   
Hardware: Any   
OS: Any   
See Also: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263317
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=278412
Bug Depends on:    
Bug Blocks: 263315    
Attachments:
Description Flags
Warn about mergemaster to etcupdate migration
none
Warn about mergemaster to etcupdate migration none

Description plastickey 2021-12-06 10:36:46 UTC 
Created attachment 229938 [details]
Warn about mergemaster to etcupdate migration

Currently the Quick Start guide to update from source (24.5.1) doesn't mention to bootstrap the etc database before updating sources and building new world and thus as a result may result in erroneous merges and conflicts. The mitigation is warned and explained in 24.5.6.1, but that is after much scrolling from quick start where the most damage could be done by an unassuming user. The attached patch corrects this by copying the warning in 24.5.6.1 to 24.5.1. This also addresses this complaint: https://lists.freebsd.org/archives/freebsd-current/2021-December/001108.html (a copy was cc'd to freebsd-doc as well).
Comment 1 Pau Amma 2021-12-06 18:58:13 UTC 
In "<.> Bootstrap the database of stock [.filename]#/etc# files, for more information see man:etcupdate[8]." (line 670), the "," after "files" should be ";" to avoid a comma splice. (If this is copied from elsewhere in the document, please change it there as well.)
Comment 2 plastickey 2021-12-06 20:13:33 UTC 
Created attachment 229943 [details]
Warn about mergemaster to etcupdate migration
Comment 3 Pau Amma 2021-12-06 23:59:47 UTC 
LGTM now, but I'm not a committer.
Comment 4 commit-hook freebsd_committer freebsd_triage 2022-11-06 21:38:38 UTC 
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=313c8a75f1c13995dfa1dee6fe6225c32f564c5a

commit 313c8a75f1c13995dfa1dee6fe6225c32f564c5a
Author:     yetoohappy <yetoohappy@gmail.com>
AuthorDate: 2022-11-06 21:36:36 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2022-11-06 21:36:36 +0000

    Add warning about migrating from mergemaster to etcupdate

    PR:             260253
    Reviewed by:    pauamma@

 .../content/en/books/handbook/cutting-edge/_index.adoc | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)
Comment 5 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2022-11-06 21:39:03 UTC 
Fixed. Thanks for the patch.
Comment 6 plastickey 2022-11-06 21:57:45 UTC 
(In reply to Sergio Carlavilla Delgado from comment #5)
Thank you. Minor issue, but it looks like conflicts (near spurious) was truncated to onflicts in your commit.