| Summary: | sys-apps/portage man page: repos.conf: description of 'volatile' inconsistent | ||
|---|---|---|---|
| Product: | Portage Development | Reporter: | Christian Becke <christianbecke> |
| Component: | Documentation | Assignee: | Portage team <dev-portage> |
| Status: | RESOLVED FIXED | ||
| Severity: | normal | CC: | esigra, sam |
| Priority: | Normal | Keywords: | InVCS, PATCH |
| Version: | unspecified | ||
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Package list: | Runtime testing required: | --- | |
| Bug Depends on: | 908971 | ||
| Bug Blocks: | |||
| Attachments: | portage(5): fix description of volatile attribute | ||
The bug has been referenced in the following commit(s): https://gitweb.gentoo.org/proj/portage.git/commit/?id=6db114e2efd6ef05dbb285698f4b104f305ff113 commit 6db114e2efd6ef05dbb285698f4b104f305ff113 Author: Christian Becke <christianbecke@web.de> AuthorDate: 2023-08-02 10:47:51 +0000 Commit: Sam James <sam@gentoo.org> CommitDate: 2023-08-08 04:50:17 +0000 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@web.de> Signed-off-by: Sam James <sam@gentoo.org> man/portage.5 | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) The bug has been referenced in the following commit(s): https://gitweb.gentoo.org/proj/portage.git/commit/?id=ac0c147f9dc0f57535390fac2181e0efefd9b48c commit ac0c147f9dc0f57535390fac2181e0efefd9b48c Author: Sam James <sam@gentoo.org> AuthorDate: 2023-08-08 04:52:06 +0000 Commit: Sam James <sam@gentoo.org> CommitDate: 2023-08-08 04:52:06 +0000 NEWS: update Bug: https://bugs.gentoo.org/911594 Signed-off-by: Sam James <sam@gentoo.org> NEWS | 2 ++ 1 file changed, 2 insertions(+) Thank you! The bug has been closed via the following commit(s): https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=858dfd771ac4c6c9315ac5851f4aeeb233fc21d5 commit 858dfd771ac4c6c9315ac5851f4aeeb233fc21d5 Author: Sam James <sam@gentoo.org> AuthorDate: 2023-08-09 02:54:12 +0000 Commit: Sam James <sam@gentoo.org> CommitDate: 2023-08-09 02:54:12 +0000 sys-apps/portage: add 3.0.50 Closes: https://bugs.gentoo.org/908971 Closes: https://bugs.gentoo.org/640658 Closes: https://bugs.gentoo.org/894398 Closes: https://bugs.gentoo.org/895908 Closes: https://bugs.gentoo.org/909067 Closes: https://bugs.gentoo.org/909148 Closes: https://bugs.gentoo.org/909853 Closes: https://bugs.gentoo.org/910035 Closes: https://bugs.gentoo.org/910376 Closes: https://bugs.gentoo.org/911594 Closes: https://bugs.gentoo.org/911574 Signed-off-by: Sam James <sam@gentoo.org> sys-apps/portage/Manifest | 1 + sys-apps/portage/portage-3.0.50.ebuild | 229 +++++++++++++++++++++++++++++++++ 2 files changed, 230 insertions(+) |
Created attachment 866842 [details, diff] 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." Attached patch contains my attempt at rewording it.