Adding documentation inspired by a virtual drink with an anonymous man in New Jersey

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@46387 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/channels/chan_sip.c b/channels/chan_sip.c
index b60e19e..4d64637 100644 (file)
--- a/channels/chan_sip.c
+++ b/channels/chan_sip.c
@@ -962,7 +962,13 @@ struct sip_pvt {
        char lastmsg[256];                      /*!< Last Message sent/received */
        int amaflags;                           /*!< AMA Flags */
        int pendinginvite;                      /*!< Any pending invite ? (seqno of this) */
-       struct sip_request initreq;             /*!< Initial request that opened the SIP dialog */
+       struct sip_request initreq;             /*!< Initial request that opened the SIP dialog 
+                                                       ... but keeps getting overwritten, so
+                                                       when we want to send a BYE or a CANCEL,
+                                                       we might be totally lost and have no
+                                                       record of what opened the dialog...
+                                                       XXX BUG!!! XXX
+                                               */
        
        int maxtime;                            /*!< Max time for first response */
        int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */