Skip to content

Commit

Permalink
flux_reactor_create(3): drop active_incref/decref
Browse files Browse the repository at this point in the history
Problem: flux_reactor_active_incref() and flux_reactor_active_decref()
appear in man pages but are no longer available.

Remove them.
  • Loading branch information
garlick committed Dec 20, 2024
1 parent 2e37fd2 commit 8718f03
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 18 deletions.
2 changes: 0 additions & 2 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,6 @@ MAN3_FILES_SECONDARY = \
man3/flux_reactor_run.3 \
man3/flux_reactor_stop.3 \
man3/flux_reactor_stop_error.3 \
man3/flux_reactor_active_incref.3 \
man3/flux_reactor_active_decref.3 \
man3/flux_fd_watcher_get_fd.3 \
man3/flux_watcher_stop.3 \
man3/flux_watcher_is_active.3 \
Expand Down
14 changes: 0 additions & 14 deletions doc/man3/flux_reactor_create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ SYNOPSIS
void flux_reactor_stop_error (flux_reactor_t *r);
void flux_reactor_active_incref (flux_reactor_t *r);
void flux_reactor_active_decref (flux_reactor_t *r);
Link with :command:`-lflux-core`.

DESCRIPTION
Expand Down Expand Up @@ -81,16 +77,6 @@ The caller should ensure that a valid error code has been assigned to
:func:`flux_reactor_create` time. Freeing of the underlying resources will
be deferred if there are any remaining watchers associated with the reactor.

:func:`flux_reactor_active_decref` and :func:`flux_reactor_active_incref`
manipulate the reactor's internal count of active watchers. Each active
watcher takes a reference count on the reactor, and the reactor returns
when this count reaches zero. It is useful sometimes to have a watcher that
can remain active without preventing the reactor from exiting. To achieve this,
call :func:`flux_reactor_active_decref` after the watcher is started, and
:func:`flux_reactor_active_incref` before the watcher is stopped.
Remember that destroying an active reactor internally stops it,
so be sure to stop/incref such a watcher first.


RETURN VALUE
============
Expand Down
2 changes: 0 additions & 2 deletions doc/manpages.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,6 @@
('man3/flux_reactor_create', 'flux_reactor_run', 'create/destroy/control event reactor object', [author], 3),
('man3/flux_reactor_create', 'flux_reactor_stop', 'create/destroy/control event reactor object', [author], 3),
('man3/flux_reactor_create', 'flux_reactor_stop_error', 'create/destroy/control event reactor object', [author], 3),
('man3/flux_reactor_create', 'flux_reactor_active_incref', 'create/destroy/control event reactor object', [author], 3),
('man3/flux_reactor_create', 'flux_reactor_active_decref', 'create/destroy/control event reactor object', [author], 3),
('man3/flux_reactor_create', 'flux_reactor_create', 'create/destroy/control event reactor object', [author], 3),
('man3/flux_reactor_now', 'flux_reactor_now_update', 'get/update reactor time', [author], 3),
('man3/flux_reactor_now', 'flux_reactor_now', 'get/update reactor time', [author], 3),
Expand Down

0 comments on commit 8718f03

Please sign in to comment.