From 5a7892a85913fa811800510b1f7de310c93f44f3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ion=20Gazta=C3=B1aga?= <igaztanaga@gmail.com>
Date: Thu, 4 Aug 2016 23:44:01 +0200
Subject: [PATCH] Document is_linked behaviour for slists with option
 linear<true>, as mentioned in Trac ticket #10328 ("is_linked is broken for
 linear slist")

---
 include/boost/intrusive/slist_hook.hpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/boost/intrusive/slist_hook.hpp b/include/boost/intrusive/slist_hook.hpp
index eac2737..c3f5ffd 100644
--- a/include/boost/intrusive/slist_hook.hpp
+++ b/include/boost/intrusive/slist_hook.hpp
@@ -270,6 +270,11 @@ class slist_member_hook
    //!   otherwise. This function can be used to test whether \c slist::iterator_to
    //!   will return a valid iterator.
    //!
+   //! <b>Note</b>: If this member is called when the value is inserted in a
+   //!   slist with the option linear<true>, this function will return "false"
+   //!   for the last element, as it is not linked to anything (the next element is null),
+   //!   so use with care.
+   //!  
    //! <b>Complexity</b>: Constant
    bool is_linked() const;