Correct fiber_cancel() documentation

Resolves #3088

Author: Gumix

doc/dev_guide/reference_capi/fiber.rst

@@ -69,11 +69,13 @@
 
 .. c:function:: void fiber_cancel(struct fiber *f)
 
-    Cancel the subject fiber (set ``FIBER_IS_CANCELLED`` flag)
+    Cancel the subject fiber.
 
-    If target fiber's flag ``FIBER_IS_CANCELLABLE`` set, then it would be woken
-    up (maybe prematurely). Then current fiber yields until the target fiber is
-    dead (or is woken up by :ref:`fiber_wakeup()<c_api-fiber-fiber_wakeup>`).
+    Cancellation is asynchronous. Use :ref:`fiber_join()<c_api-fiber-fiber_join>`
+    to wait for the cancellation to complete.
+
+    After ``fiber_cancel()`` is called, the fiber may or may not check whether it
+    was cancelled. If the fiber does not check it, it cannot ever be cancelled.
 
     :param struct fiber* f: fiber to be cancelled
 
@@ -96,6 +98,8 @@
     :param struct fiber* f: fiber
     :param bool      yesno: status to set
 
+.. _c_api-fiber-fiber_join:
+
 .. c:function:: void fiber_join(struct fiber *f)
 
     Wait until the fiber is dead and then move its execution status to the

locale/ru/LC_MESSAGES/dev_guide/reference_capi/fiber.po

@@ -85,18 +85,22 @@ msgstr "Прерывание синхронного ожидания файбе
 msgid "fiber to be woken up"
 msgstr "пробуждаемый файбер"
 
-msgid "Cancel the subject fiber (set ``FIBER_IS_CANCELLED`` flag)"
-msgstr "Отмена файбера (установка флага ``FIBER_IS_CANCELLED``)"
+msgid "Cancel the subject fiber."
+msgstr "Отмена файбера."
 
 msgid ""
-"If target fiber's flag ``FIBER_IS_CANCELLABLE`` set, then it would be woken "
-"up (maybe prematurely). Then current fiber yields until the target fiber is "
-"dead (or is woken up by :ref:`fiber_wakeup()<c_api-fiber-fiber_wakeup>`)."
+"Cancellation is asynchronous. Use :ref:`fiber_join()<c_api-fiber-fiber_join>` "
+"to wait for the cancellation to complete."
 msgstr ""
-"Если на нужном файбере установлен флаг ``FIBER_IS_CANCELLABLE``, он "
-"возобновит работу (возможно досрочно). Тогда текущий файбер передает "
-"управление до тех пор, пока нужный файбер не будет удален (или не возобновит"
-" работу с помощью :ref:`fiber_wakeup()<c_api-fiber-fiber_wakeup>`)."
+"Отмена файбера происходит асинхронно. Чтобы дождаться окончания отмены, "
+"используйте :ref:`fiber_join()<c_api-fiber-fiber_join>`."
+
+msgid ""
+"After ``fiber_cancel()`` is called, the fiber may or may not check whether it "
+"was cancelled. If the fiber does not check it, it cannot ever be cancelled."
+msgstr ""
+"После вызова ``fiber_cancel()`` файбер может проверить, был ли он отменен. "
+"Если он этого не сделает, его отменить невозможно. "
 
 msgid "fiber to be cancelled"
 msgstr "отменяемый файбер"