From 9ec04e006e57903048d3a90ba652fb133d6ca30e Mon Sep 17 00:00:00 2001
From: "Daniel A. Wozniak" <daniel.wozniak@broadcom.com>
Date: Tue, 13 Aug 2024 17:53:39 -0700
Subject: [PATCH] Add docstring to ipc_publish_server

---
 salt/transport/base.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/salt/transport/base.py b/salt/transport/base.py
index 38529cd9bfb..66deaa15bdd 100644
--- a/salt/transport/base.py
+++ b/salt/transport/base.py
@@ -211,6 +211,14 @@ def ipc_publish_client(node, opts, io_loop):
 
 
 def ipc_publish_server(node, opts):
+    """
+    Create an IPC publish server.
+
+    With the exception of a master's pull_path, all ipc path permission have
+    user read/write permissions. On a master the ipc publish server's pull_path
+    permissions are also group read/write. This is done to facilitate non root
+    users running the salt cli to execute jobs on a master.
+    """
     # Default to TCP for now
     kwargs = {"transport": "tcp", "ssl": None}
     if opts["ipc_mode"] == "tcp":