mercurial/scmutil.py
changeset 49666 4bd12c0f531e
parent 49450 b57c95a0f5f9
child 49972 1bd33932713d
--- a/mercurial/scmutil.py	Fri Nov 25 15:14:40 2022 +0100
+++ b/mercurial/scmutil.py	Mon Oct 17 16:26:16 2022 +0200
@@ -1858,7 +1858,12 @@
 
 
 def gddeltaconfig(ui):
-    """helper function to know if incoming delta should be optimised"""
+    """helper function to know if incoming deltas should be optimized
+
+    The `format.generaldelta` config is an old form of the config that also
+    implies that incoming delta-bases should be never be trusted. This function
+    exists for this purpose.
+    """
     # experimental config: format.generaldelta
     return ui.configbool(b'format', b'generaldelta')