From d0e68ac125b0a049eb71b81904336e51b1da3ac1 Mon Sep 17 00:00:00 2001 From: Zac Medico Date: Mon, 30 Jul 2007 01:30:17 +0000 Subject: [PATCH] For bug #137483, move the `emerge --help config` docs to the emerge man page. Thanks to Arfrever Frehtes Taifersar Arahesis for this patch. (trunk r7430) svn path=/main/branches/2.1.2/; revision=7431 --- bin/emerge | 5 +++-- man/emerge.1 | 37 +++++++++++++++++++++++++++++++++++++ pym/emergehelp.py | 44 -------------------------------------------- 3 files changed, 40 insertions(+), 46 deletions(-) diff --git a/bin/emerge b/bin/emerge index fa8862181..7202174b2 100755 --- a/bin/emerge +++ b/bin/emerge @@ -4384,8 +4384,9 @@ def chk_updated_cfg_files(target_root, config_protect): print "config file '%s' needs updating." % x if procount: - #print " "+yellow("*")+" Type "+green("emerge --help config")+" to learn how to update config files." - print " "+yellow("*")+" Type "+green("emerge --help config")+" to learn how to update config files." + print " "+yellow("*")+" See the "+colorize("INFORM","CONFIGURATION FILES")+ \ + " section of the " + bold("emerge") + print " "+yellow("*")+" man page to learn how to update config files." def is_valid_package_atom(x): try: diff --git a/man/emerge.1 b/man/emerge.1 index 3987f4e0c..203fa1eb6 100644 --- a/man/emerge.1 +++ b/man/emerge.1 @@ -553,6 +553,43 @@ variable to allow or disallow the emerging of a package masked by versions of packages, you should update your \fI/etc/portage/package.keywords\fR file to list the packages you want the \'testing\' version. See \fBportage\fR(5) for more information. +.SH "CONFIGURATION FILES" +Portage has a special feature called "config file protection". The purpose of +this feature is to prevent new package installs from clobbering existing +configuration files. By default, config file protection is turned on for /etc +and the KDE configuration dirs; more may be added in the future. +.LP +When Portage installs a file into a protected directory tree like /etc, any +existing files will not be overwritten. If a file of the same name already +exists, Portage will change the name of the to\-be\-installed file from 'foo' to +\'._cfg0000_foo\'. If \'._cfg0000_foo\' already exists, this name becomes +\'._cfg0001_foo\', etc. In this way, existing files are not overwritten, +allowing the administrator to manually merge the new config files and avoid any +unexpected changes. +.LP +In addition to protecting overwritten files, Portage will not delete any files +from a protected directory when a package is unmerged. While this may be a +little bit untidy, it does prevent potentially valuable config files from being +deleted, which is of paramount importance. +.LP +Protected directories are set using the \fICONFIG_PROTECT\fR variable, normally +defined in /etc/make.globals. Directory exceptions to the CONFIG_PROTECTed +directories can be specified using the \fICONFIG_PROTECT_MASK\fR variable. To find +files that need to be updated in /etc, type \fBfind /etc \-iname \'._cfg????_*\'\fR. +.LP +You can disable this feature by setting \fICONFIG_PROTECT="\-*"\fR in /etc/make.conf. +Then, Portage will mercilessly auto\-update your config files. Alternatively, +you can leave Config File Protection on but tell Portage that it can overwrite +files in certain specific /etc subdirectories. For example, if you wanted +Portage to automatically update your rc scripts and your wget configuration, +but didn't want any other changes made without your explicit approval, you'd +add this to /etc/make.conf: +.LP +.I CONFIG_PROTECT_MASK="/etc/wget /etc/rc.d" +.LP +Tools such as dispatch\-conf, cfg\-update, and etc\-update are also available to +aid in the merging of these files. They provide interactive merging and can +auto\-merge trivial changes. .SH "REPORTING BUGS" Please report any bugs you encounter through our website: .LP diff --git a/pym/emergehelp.py b/pym/emergehelp.py index 8ac754ce9..a9acac607 100644 --- a/pym/emergehelp.py +++ b/pym/emergehelp.py @@ -391,48 +391,4 @@ def help(myaction,myopts,havecolor=1): print " versions or newer ebuilds have become available since you last did a" print " sync and update." print - elif myaction=="config": - outstuff=green("Config file management support (preliminary)")+""" - -Portage has a special feature called "config file protection". The purpose of -this feature is to prevent new package installs from clobbering existing -configuration files. By default, config file protection is turned on for /etc -and the KDE configuration dirs; more may be added in the future. - -When Portage installs a file into a protected directory tree like /etc, any -existing files will not be overwritten. If a file of the same name already -exists, Portage will change the name of the to-be-installed file from 'foo' to -'._cfg0000_foo'. If '._cfg0000_foo' already exists, this name becomes -'._cfg0001_foo', etc. In this way, existing files are not overwritten, -allowing the administrator to manually merge the new config files and avoid any -unexpected changes. - -In addition to protecting overwritten files, Portage will not delete any files -from a protected directory when a package is unmerged. While this may be a -little bit untidy, it does prevent potentially valuable config files from being -deleted, which is of paramount importance. - -Protected directories are set using the CONFIG_PROTECT variable, normally -defined in /etc/make.globals. Directory exceptions to the CONFIG_PROTECTed -directories can be specified using the CONFIG_PROTECT_MASK variable. To find -files that need to be updated in /etc, type: - -# find /etc -iname '._cfg????_*' - -You can disable this feature by setting CONFIG_PROTECT="-*" in /etc/make.conf. -Then, Portage will mercilessly auto-update your config files. Alternatively, -you can leave Config File Protection on but tell Portage that it can overwrite -files in certain specific /etc subdirectories. For example, if you wanted -Portage to automatically update your rc scripts and your wget configuration, -but didn't want any other changes made without your explicit approval, you'd -add this to /etc/make.conf: - -CONFIG_PROTECT_MASK="/etc/wget /etc/rc.d" - -Tools such as dispatch-conf, cfg-update, and etc-update are also available to -aid in the merging of these files. They provide interactive merging and can -auto-merge trivial changes. - -""" - print outstuff -- 2.26.2