Add comment regarding fsanitize + Clang issue

We could not figure out the root issue, or at least not to the point
where we felt changing this code considering we could not trigger
any bug from a user perspective.

For now, we just add a comment in the code.

For more information, see our ML discussion here:

  https://www.mail-archive.com/search?l=mid&q=20211227113249.53bf5a63%40admin1-desktop

diff --git a/src/support/socktools.cpp b/src/support/socktools.cpp
index d4aab38f5fec0306766a8cca0394d48e5eb114e2..d014f45e9483284b77ace0c3b9cb21b8171a7927 100644 (file)
--- a/src/support/socktools.cpp
+++ b/src/support/socktools.cpp
@@ -111,6 +111,13 @@ int listen(FileName const & name, int queue)
        // bind() gives the local address 'name' for 'fd', also creating
        // the socket special file in the filesystem. bind() returns -1
        // in case of error
+       //
+       // Using Clang and fsanitize suggests there is an issue here but we do
+       // not understand the code enough to change it and we are not aware of
+       // how to trigger a crash or other issue while using LyX, so we leave
+       // it as is. For ML discussion, see here:
+       //   https://www.mail-archive.com/search?l=mid&q=20211227113249.53bf5a63%40admin1-desktop
+       //
        if ((::bind (fd, reinterpret_cast<sockaddr *>(&addr), SUN_LEN(&addr))) == -1) {
                LYXERR0("lyx: Could not bind address '" << name.absFileName()
                       << "' to socket descriptor: " << strerror(errno));