[gentoo-commits] proj/portage:master commit in: lib/portage/sync/modules/webrsync/

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

commit:     7af691adef9a624cde540850f39a6bf1b8d5e2bf
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Wed Mar 29 22:06:56 2023 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sun Apr  9 06:51:34 2023 +0000
URL:        https://gitweb.gentoo.org/proj/portage.git/commit/?id=7af691ad

sync: webrsync: document status quo

Signed-off-by: Sam James <sam <AT> gentoo.org>

 lib/portage/sync/modules/webrsync/webrsync.py | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/lib/portage/sync/modules/webrsync/webrsync.py b/lib/portage/sync/modules/webrsync/webrsync.py
index f98162683..b4a6bb4f8 100644
--- a/lib/portage/sync/modules/webrsync/webrsync.py
+++ b/lib/portage/sync/modules/webrsync/webrsync.py
@@ -7,11 +7,11 @@ from portage import os
 from portage.util import writemsg_level
 from portage.util.futures import asyncio
 from portage.output import create_color_func
+from portage.sync.syncbase import SyncBase
 
 good = create_color_func("GOOD")
 bad = create_color_func("BAD")
 warn = create_color_func("WARN")
-from portage.sync.syncbase import SyncBase
 
 try:
     from gemato.exceptions import GematoException
@@ -21,7 +21,15 @@ except ImportError:
 
 
 class WebRsync(SyncBase):
-    """WebRSync sync class"""
+    """WebRSync sync class
+
+    This class implements syncing via calls to an external binary, either:
+    - emerge-delta-webrsync (if sync-webrsync-delta is set), or
+    - emerge-webrsync
+
+    It wraps them and performs PGP verification if sync-webrsync-verify-signature
+    is set via gemato.
+    """
 
     short_desc = "Perform sync operations on webrsync based repositories"
 
@@ -133,7 +141,12 @@ class WebRsync(SyncBase):
 
 
 class PyWebRsync(SyncBase):
-    """WebRSync sync class"""
+    """PyWebRsync sync class
+
+    TODO: Implement the sync parts from the emerge-webrsync external
+          binary to avoid split logic for various components, which
+          is how we ended up with bug #597800.
+    """
 
     short_desc = "Perform sync operations on webrsync based repositories"