1 .\" Copyright (c) 2010-2013 Advanced Computing Technologies LLC
2 .\" Written by: John H. Baldwin <jhb@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd "manage updates to system files not updated by installworld"
38 .Op Fl r | Fl s Ar source | Fl t Ar tarball
62 .Op Fl s Ar source | Fl t Ar tarball
78 utility is a tool for managing updates to files that are not updated as
83 It manages updates by doing a three-way merge of changes made to these
84 files against the local versions.
85 It is also designed to minimize the amount of user intervention with
86 the goal of simplifying upgrades for clusters of machines.
88 To perform a three-way merge,
90 keeps copies of the current and previous versions of files that it manages.
91 These copies are stored in two trees known as the
102 copies of each file to determine which changes need to be merged into the
103 local version of each file.
104 If a file can be updated without generating a conflict,
106 will update the file automatically.
107 If the local changes to a file conflict with the changes made to a file in
109 then a merge conflict is generated.
110 The conflict must be resolved after the merge has finished.
113 utility will not perform a new merge until all conflicts from an earlier
118 utility supports several modes of operation.
119 The mode is specified via an optional command argument.
120 If present, the command must be the first argument on the command line.
121 If a command is not specified, the default mode is used.
123 The default mode merges changes from the source tree to the destination
132 it compares the two trees merging changes into the destination directory.
134 it displays warnings for any conditions it could not handle automatically.
138 option is not specified,
139 then the first step taken is to update the
147 then that tree is saved as the
152 tree is removed if it exists.
155 tree is built from a source tree.
157 if a tarball is specified via the
160 then the tree is extracted from that tarball instead.
164 compares the files in the
169 If a file was removed from the
172 then it will be removed from the destination directory only if it
173 does not have any local modifications.
174 If a file was added to the
177 then it will be copied to the destination directory only if it
178 would not clobber an existing file.
179 If a file is changed in the
184 will attempt to merge the changes into the version of the file in the
185 destination directory.
186 If the merge encounters conflicts,
187 then a version of the file with conflict markers will be saved for
189 If the merge does not encounter conflicts,
190 then the merged version of the file will be saved in the destination
194 is not able to safely merge in changes to a file other than a merge conflict,
195 it will generate a warning.
197 For each file that is updated a line will be output with a leading character
198 to indicate the action taken.
199 The possible actions follow:
201 .Bl -tag -width "A" -compact -offset indent
215 if any warnings were encountered they are displayed after the merge has
218 Note that for certain files
220 will perform post-install actions any time that the file is updated.
224 .Pa /etc/master.passwd
228 .Pa /etc/login.conf.db
234 .Pa /etc/mail/aliases
241 One exception is that if
242 .Pa /etc/mail/aliases
243 is changed and the destination directory is not the default,
244 then a warning will be issued instead.
245 This is due to a limitation of the
251 is changed and the destination directory is not the default,
254 will not be executed due to a limitation of that script.
255 In this case no warning is issued as the result of
257 is merely cosmetic and will be corrected on the next reboot.
261 mode is used to build a tarball that contains a snapshot of a
264 This tarball can be used by the default and extract modes.
265 Using a tarball can allow
267 to perform a merge without requiring a source tree that matches the
268 currently installed world.
271 argument specifies the name of the file to create.
279 mode compares the versions of files in the destination directory to the
281 tree and generates a unified format diff of the changes.
282 This can be used to determine which files have been locally modified and how.
285 does not manage files that are not maintained in the source tree such as
295 Unlike the default mode,
296 it does not save any existing
298 tree and does not modify any existing
303 tree can either be built from a source tree or extracted from a tarball.
307 mode is used to resolve any conflicts encountered during a merge.
310 iterates over any existing conflicts prompting the user for actions to take
311 on each conflicted file.
312 For each file, the following actions are available:
314 .Bl -tag -width "(tf) theirs-full" -compact
316 Ignore this conflict for now.
318 Show all changes made to the merged file as a unified diff.
320 Change the merged file in an editor.
322 Install the merged version of the file into the destination directory.
324 Use the version of the file in the destination directory and ignore any
325 changes made to the file in the
329 Use the version of the file from the
331 tree and discard any local changes made to the file.
333 Display the list of commands.
338 mode shows a summary of the results of the most recent merge.
339 First it lists any files for which there are unresolved conflicts.
340 Next it lists any warnings generated during the last merge.
341 If the last merge did not generate any conflicts or warnings,
342 then nothing will be output.
344 The following options are available.
345 Note that most options do not apply to all modes.
346 .Bl -tag -width ".Fl A Ar patterns"
348 Always install the new version of any files that match any of the patterns
351 Each pattern is evaluated as an
354 This option may be specified multiple times to specify multiple patterns.
355 Multiple space-separated patterns may also be specified in a single
357 Note that ignored files specified via the
361 option will not be installed.
363 Do not build generated files in a private object tree.
365 reuse the generated files from a previously built object tree that matches
367 This can be useful to avoid gratuitous conflicts in
370 files when bootstrapping.
371 It can also be useful for building a tarball that matches a specific
374 Specify an alternate destination directory as the target of a merge.
375 This is analogous to the
378 .Sq make installworld .
379 The default destination directory is an empty string which results in
382 on the local machine.
384 Specify an alternate directory to use as the work directory.
385 The work directory is used to store the
389 trees as well as unresolved conflicts.
390 The default work directory is
391 .Pa <destdir>/var/db/etcupdate .
393 Ignore changes in the FreeBSD ID string when comparing files in the
394 destination directory to files in either of the
402 this reduces noise due to FreeBSD ID string changes in the output.
403 During an update this can simplify handling for harmless conflicts caused
404 by FreeBSD ID string changes.
407 if a file in the destination directory is identical to the same file in the
409 tree modulo the FreeBSD ID string,
410 then the file is treated as if it was unmodified and the
412 version of the file will be installed.
414 if a file in the destination directory is identical to the same file in the
416 tree modulo the FreeBSD ID string,
419 version of the file will be installed to update the ID string.
424 versions of the file are identical,
427 will not change the file in the destination directory.
429 Due to limitations in the
432 this option may not have an effect if there are other changes in a file that
433 are close to the FreeBSD ID string.
435 Ignore any files that match any of the patterns listed in
437 No warnings or other messages will be generated for those files during a
439 Each pattern is evaluated as an
442 This option may be specified multiple times to specify multiple patterns.
443 Multiple space-separated patterns may also be specified in a single
446 Specify an alternate path for the log file.
449 utility logs each command that it invokes along with the standard output
450 and standard error to this file.
451 By default the log file is stored in a file named
453 in the work directory.
457 as additional parameters to
462 This can be used for to set the
466 variables for a cross-build.
471 Do not merge any changes to the destination directory.
473 report what actions would be taken during a merge.
474 Note that the existing
478 trees will not be changed.
481 option is not specified,
484 tree will be extracted to perform the comparison.
489 Only merge changes to files that are necessary to successfully run
490 .Sq make installworld
492 .Sq make installkernel .
493 When this flag is enabled,
498 trees are left alone.
500 a temporary tree is populated with the necessary files.
501 This temporary tree is compared against the
504 This allows a normal update to be run after
505 .Sq make installworld
507 Any conflicts generated during a
509 update should be resolved by a
517 trees during a merge.
520 a previous merge operation.
522 Specify an alternate source tree to use when building or extracting a
525 The default source tree is
530 tree from a tarball previously generated by the
532 command rather than building the tree from a source tree.
537 utility can also be configured by setting variables in an optional
538 configuration file named
539 .Pa /etc/etcupdate.conf .
540 Note that command line options override settings in the configuration file.
541 The configuration file is executed by
543 so it uses that syntax to set configuration variables.
544 The following variables can be set:
545 .Bl -tag -width ".Ev ALWAYS_INSTALL"
546 .It Ev ALWAYS_INSTALL
547 Always install files that match any of the patterns listed in this variable
552 Specify an alternate destination directory similar to the
556 Specify a program to edit merge conflicts.
558 Ignore changes in the FreeBSD ID string similar to the
561 This is enabled by setting the variable to a non-empty value.
563 Ignore files that match any of the patterns listed in this variable
568 Specify an alternate path for the log file similar to the
572 Pass additional options to
580 Specify an alternate source tree similar to the
584 Specify an alternate work directory similar to the
591 utility uses the program identified in the
593 environment variable to edit merge conflicts.
598 is used as the default editor.
600 .Bl -tag -width ".Pa /var/db/etcupdate/log" -compact
601 .It Pa /etc/etcupdate.conf
602 Optional config file.
603 .It Pa /var/db/etcupdate
604 Default work directory used to store trees and other data.
605 .It Pa /var/db/etcupdate/log
611 To compare the files in
613 with the stock versions:
617 To merge changes after an upgrade via the buildworld and installworld process:
621 To resolve any conflicts generated during a merge:
623 .Dl "etcupdate resolve"
627 utility may need to be bootstrapped before it can be used.
630 command will fail with an error about a missing reference tree if
631 bootstrapping is needed.
635 requires a source tree that matches the currently installed world.
636 The easiest way to ensure this is to bootstrap
638 before updating the source tree to start the next world upgrade cycle.
640 generate a reference tree:
642 .Dl "etcupdate extract"
647 command to compare the reference tree to your current files in
649 Undesired differences should be removed using an editor,
651 or by copying files from the reference tree
654 .Pa /var/db/etcupdate/current
661 is already newer than the currently installed world,
662 a new tree matching the currently installed world can be checked out to
663 a temporary location.
664 The reference tree for
666 can then be generated via:
668 .Dl "etcupdate extract -s /path/to/tree"
672 command can be used as above to remove undesired differences.
674 the changes in the tree at
676 can be merged via a regular merge.
678 The following warning messages may be generated during a merge.
679 Note that several of these warnings cover obscure cases that should occur
680 rarely if at all in practice.
682 if a file changes from a file to a directory in the
685 and the file was modified in the destination directory,
686 then a warning will be triggered.
688 when a warning references a pathname,
689 the corresponding file in the destination directory is not changed by a
692 .It "Directory mismatch: <path> (<type>)"
693 An attempt was made to create a directory at
695 but an existing file of type
697 already exists for that path name.
698 .It "Modified link changed: <file> (<old> became <new>)"
699 The target of a symbolic link named
708 The symbolic link has been modified to point to a target that is neither
712 in the destination directory.
713 .It "Modified mismatch: <file> (<new> vs <dest>)"
721 but the file exists as a different type
723 in the destination directory.
724 .It "Modified <type> changed: <file> (<old> became <new>)"
736 The file in the destination directory of type
739 so it could not be merged automatically.
740 .It "Modified <type> remains: <file>"
745 has been removed from the
748 but it has been locally modified.
749 The modified version of the file remains in the destination directory.
750 .It "Needs update: /etc/localtime (required manual update via tzsetup(1))"
756 was not able to refresh
758 from its source file in
759 .Fa /usr/share/zoneinfo .
766 permitting future updates to refresh
769 .It "Needs update: /etc/mail/aliases.db (required manual update via newaliases(1))"
771 .Pa /etc/mail/aliases
772 was updated during a merge with a non-empty destination directory.
773 Due to a limitation of the
777 was not able to automatically update the corresponding aliases database.
778 .It "New file mismatch: <file> (<new> vs <dest>)"
783 has been added to the
786 A file of that name already exists in the destination directory,
787 but it is of a different type
789 .It "New link conflict: <file> (<new> vs <dest>)"
790 A symbolic link named
792 has been added to the
796 A symbolic link of the same name already exists in the destination
798 but it links to a different target
800 .It "Non-empty directory remains: <file>"
806 but it contains additional files in the destination directory.
807 These additional files as well as the directory remain.
808 .It "Remove mismatch: <file> (<old> became <new>)"
820 but it has been removed in the destination directory.
821 .It "Removed file changed: <file>"
827 but it has been removed in the destination directory.
828 .It "Removed link changed: <file> (<old> became <new>)"
829 The target of a symbolic link named
838 but it has been removed in the destination directory.
850 utility first appeared in
855 utility was written by
856 .An John Baldwin Aq Mt jhb@FreeBSD.org .
858 Rerunning a merge does not automatically delete conflicts left over from a
860 Any conflicts must be resolved before the merge can be rerun.
861 It it is not clear if this is a feature or a bug.
863 There is no way to easily automate conflict resolution for specific files.
864 For example, one can imagine a syntax along the lines of
866 .Dl "etcupdate resolve tf /some/file"
868 to resolve a specific conflict in an automated fashion.
870 It might be nice to have something like a
872 command to replace a locally modified version of a file with the stock
876 .Dl "etcupdate revert /etc/mail/freebsd.cf"
880 often results in gratuitous diffs in
882 that cause conflicts in the first merge.
883 If an object tree that matches the source tree is present when bootstrapping,
888 command can work around this.