[gentoo-commits] proj/portage:master commit in: man/

["Sam James" <sam@gentoo.org>]

commit:     6db114e2efd6ef05dbb285698f4b104f305ff113
Author:     Christian Becke <christianbecke <AT> web <DOT> de>
AuthorDate: Wed Aug  2 10:47:51 2023 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Tue Aug  8 04:50:17 2023 +0000
URL:        https://gitweb.gentoo.org/proj/portage.git/commit/?id=6db114e2

portage(5): fix description of volatile attribute

The description of the 'volatile' keyword in the 'repos.conf' section in the portage(5)
man page seems to be inconsistent.

I think the first two sentences correctly describe the behaviour of 'volatile' and
agree with the comments in portage/repository/config.py:
"Specifies whether a repository is volatile.  Volatile repositories are assumed to
contain changes made outside of Portage.  This prohibits optimizations from occurring
by assuming the integrity of the repository and its caches may be  violated."

The remainder of the paragraph inverts the meaning of 'volatile' and does not
agree with the code in portage/repository/config.py:
"Disabling this option allows local changes to be made to the repository for
e.g. development safely.  For git-synced repositories, Portage will not perform
destructive operations.  Per default, repositories are considered volatile if
their directory is owned by either 'root' or 'portage' and if it is under
/var/db/repos. Otherwise, the repository is considered non volatile."

Bug: https://bugs.gentoo.org/911594
Signed-off-by: Christian Becke <christianbecke <AT> web.de>
Signed-off-by: Sam James <sam <AT> gentoo.org>

 man/portage.5 | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/man/portage.5 b/man/portage.5
index 4bae67720..1c0ce22bd 100644
--- a/man/portage.5
+++ b/man/portage.5
@@ -1265,11 +1265,11 @@ sync\-openpgp\-key\-path setting. Defaults to no, false.
 Specifies whether a repository is volatile.  Volatile repositories
 are assumed to contain changes made outside of Portage.  This prohibits
 optimizations from occurring by assuming the integrity of the repository
-and its caches may be violated.  Disabling this option allows local changes to
-be made to the repository for e.g. development safely.  For git-synced
-repositories, Portage will not perform destructive operations.
-Per default, repositories are considered volatile if their directory is owned
-by either 'root' or 'portage' and if it is under /var/db/repos. Otherwise,
+and its caches may be violated.  Enabling this option allows local changes to
+be made to the repository for e.g. development safely.  When enabled, Portage
+will not perform destructive operations for git-synced repositories.  Per
+default, repositories are considered volatile if their directory is not owned
+by either 'root' or 'portage' or if it is not under /var/db/repos.  Otherwise,
 the repository is considered non volatile.
 .TP