From: Timo Sirainen <timo.sirainen@open-xchange.com>
Date: Sat, 4 Apr 2020 21:43:37 +0000 (+0300)
Subject: lib-login: Add comments to .h file headers explaining what they are doing
X-Git-Tag: 2.4.0~3921
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cd23df3040975a6eaa65564ebfeaf56db932454e;p=thirdparty%2Fdovecot%2Fcore.git

lib-login: Add comments to .h file headers explaining what they are doing
---

diff --git a/src/lib-login/login-client.h b/src/lib-login/login-client.h
index a6b038f0f5..345027ef80 100644
--- a/src/lib-login/login-client.h
+++ b/src/lib-login/login-client.h
@@ -1,6 +1,10 @@
 #ifndef LOGIN_CLIENT_H
 #define LOGIN_CLIENT_H
 
+/* This login-client API is used by the untrusted pre-login processes (e.g.
+   login-common). It connects to the post-login process (e.g. imap), which uses
+   login-server API to handle the login request. */
+
 #include "net.h"
 
 struct master_service;
diff --git a/src/lib-login/login-server-auth.h b/src/lib-login/login-server-auth.h
index 9939ea93c7..d243aa5c4d 100644
--- a/src/lib-login/login-server-auth.h
+++ b/src/lib-login/login-server-auth.h
@@ -1,6 +1,10 @@
 #ifndef LOGIN_SERVER_AUTH_H
 #define LOGIN_SERVER_AUTH_H
 
+/* Used for connecting to auth process via auth-master socket and sending
+   REQUEST commands to finish login requests. FIXME: This should be moved
+   to lib-auth/auth-master. */
+
 struct login_request;
 
 typedef void
diff --git a/src/lib-login/login-server.h b/src/lib-login/login-server.h
index bc44dd3455..3d459502c9 100644
--- a/src/lib-login/login-server.h
+++ b/src/lib-login/login-server.h
@@ -1,6 +1,9 @@
 #ifndef LOGIN_SERVER_H
 #define LOGIN_SERVER_H
 
+/* This login-server API is used by post-login processes (e.g. imap) to accept
+   a login request sent by the pre-login processes via login-client API. */
+
 #include "login-client.h"
 
 #define LOGIN_SERVER_POSTLOGIN_TIMEOUT_DEFAULT 60