# HG changeset patch
# User Yuya Nishihara <yuya@tcha.org>
# Date 2018-11-18 09:35:31
# Node ID 698477777883174cb8ab3b0977ea2e5368160652
# Parent  03127e5809806c718719e9547dc9fd952e7bbe5d

loggingutil: document openlogfile()

This function will be used later for command-server logging.

diff --git a/mercurial/loggingutil.py b/mercurial/loggingutil.py
--- a/mercurial/loggingutil.py
+++ b/mercurial/loggingutil.py
@@ -15,6 +15,10 @@ from . import (
 )
 
 def openlogfile(ui, vfs, name, maxfiles=0, maxsize=0):
+    """Open log file in append mode, with optional rotation
+
+    If maxsize > 0, the log file will be rotated up to maxfiles.
+    """
     def rotate(oldpath, newpath):
         try:
             vfs.unlink(newpath)