]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
CLEANUP: stconn: Move comment about sedesc fields on the field line
authorChristopher Faulet <cfaulet@haproxy.com>
Thu, 22 Jun 2023 08:55:29 +0000 (10:55 +0200)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 4 Aug 2023 12:32:57 +0000 (14:32 +0200)
Fields of sedesc structure were documented in the comment about the
structure itself. It was not really convenient, hard to read, hard to
update. So comments about the fields are moved on the corresponding field
line, as usual.

include/haproxy/stconn-t.h

index 99b6e25bda8d546a26d467f8c28c3839a5907f8b..e507e1e945582372c03ae23eeabfb32c22fb2dcf 100644 (file)
@@ -240,14 +240,6 @@ struct stconn;
  * endpoint itself (mux/applet) and eventually creates a new sedesc (for
  * instance on connection retries).
  *
- * <se>     is the stream endpoint, i.e. the mux stream or the appctx
- * <conn>   is the connection for connection-based streams
- * <sc>     is the stream connector we're attached to, or NULL
- * <lra>    is the last read activity
- * <fsb>    is the first send blocked
- * <flags>  SE_FL_*
- * <xref>   cross reference with the opposite SC
- *
  * <lra> should be updated when a read activity is detected. It can be a
  *       successful receive, when a shutr is reported or when receives are
  *       unblocked.
@@ -256,13 +248,14 @@ struct stconn;
  *       when a successful send is reported.
  */
 struct sedesc {
-       void *se;
-       struct connection *conn;
-       struct stconn *sc;
-       unsigned int flags;
-       unsigned int lra;
-       unsigned int fsb;
-       struct xref xref;
+       void *se;                  /* the stream endpoint, i.e. the mux stream or the appctx */
+       struct connection *conn;   /* the connection for connection-based streams */
+       struct stconn *sc;         /* the stream connector we're attached to, or NULL */
+       unsigned int flags;        /* SE_FL_* */
+       unsigned int lra;          /* the last read activity */
+       unsigned int fsb;          /* the first send blocked */
+       /* 4 bytes hole here */
+       struct xref xref;          /* cross reference with the opposite SC */
 };
 
 /* sc_app_ops describes the application layer's operations and notification