Bug 278412 - Duplicated mergemaster content
Summary: Duplicated mergemaster content
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-04-17 17:18 UTC by Ed Maste
Modified: 2024-04-18 16:37 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ed Maste freebsd_committer freebsd_triage 2024-04-17 17:18:49 UTC
The "When switching from mergemaster(8) to etcupdate(8)" text appears twice in https://docs.freebsd.org/en/books/handbook/cutting-edge/


$ grep -B3 -A2 'When switching from man:mergemaster' documentation/content/en/books/handbook/cutting-edge/_index.adoc

[WARNING]
====
When switching from man:mergemaster[8] to man:etcupdate[8], the first run might merge changes incorrectly generating spurious conflicts.
To prevent this, perform the following steps *before* updating sources and building the new world:

--

[WARNING]
====
When switching from man:mergemaster[8] to man:etcupdate[8], the first run might merge changes incorrectly generating spurious conflicts.
To prevent this, perform the following steps *before* updating sources and building the new world:
Comment 1 Ed Maste freebsd_committer freebsd_triage 2024-04-17 17:24:52 UTC
Relevant commits:

7859bada695 - first added
dfde7327ba0 - etcupdate bootstrap corrected to etcupdate extract
313c8a75f1c - corrected comma splice and introduced duplicate content
51b500976a2 - typo correction in duplicate content
Comment 2 Minsoo Choo 2024-04-18 01:00:51 UTC
In my opinion, keeping the warning twice seems good. Both places (at the top of the section and when merging with etcupdate) are good places to warn the users and prevent them from incorrect migration from etcupdate to mergemaster. However, if the one of them has to be removed, I would like to keep the first one.
Comment 3 Ed Maste freebsd_committer freebsd_triage 2024-04-18 16:37:27 UTC
(In reply to Minsoo Choo from comment #2)
I agree it's important to reference this in both places -- before starting the upgrade (when the steps need to be taken) and at the point in the process where it is important that the steps have been taken, and I agree that the first is the most important one. But I think the exact same text should not appear twice - the second location should have a note and cross-reference to the first.