doc: note that timeout is not always supported

Maybe people will just upgrade to newer systems eventually.

1 files changed, 9 insertions, 0 deletions

diff --git a/ext/posix_mq/posix_mq.c b/ext/posix_mq/posix_mq.c
index 3340b00..0d08698 100644
--- a/ext/posix_mq/posix_mq.c
+++ b/ext/posix_mq/posix_mq.c
@@ -510,6 +510,9 @@ static void setup_send_buffer(struct rw_args *x, VALUE buffer)
  * then Errno::ETIMEDOUT will be raised if the operation cannot complete
  * before +timeout+ seconds has elapsed.  Without +timeout+, this method
  * may block until the queue is writable.
+ *
+ * On some older systems, the +timeout+ argument is not currently
+ * supported and may raise NotImplementedError if +timeout+ is used.
  */
 static VALUE _send(int argc, VALUE *argv, VALUE self)
 {
@@ -604,6 +607,9 @@ static VALUE _receive(int wantarray, int argc, VALUE *argv, VALUE self);
  * or Integer specifying the timeout in seconds.  Errno::ETIMEDOUT
  * will be raised if +timeout+ has elapsed and there are no messages
  * in the queue.
+ *
+ * On some older systems, the +timeout+ argument is not currently
+ * supported and may raise NotImplementedError if +timeout+ is used.
  */
 static VALUE receive(int argc, VALUE *argv, VALUE self)
 {
@@ -624,6 +630,9 @@ static VALUE receive(int argc, VALUE *argv, VALUE self)
  * or Integer specifying the timeout in seconds.  Errno::ETIMEDOUT
  * will be raised if +timeout+ has elapsed and there are no messages
  * in the queue.
+ *
+ * On some older systems, the +timeout+ argument is not currently
+ * supported and may raise NotImplementedError if +timeout+ is used.
  */
 static VALUE shift(int argc, VALUE *argv, VALUE self)
 {