diff mbox

epoll_ctl.2: minor clarification concerning when a WAKEUP event is "processes"

Message ID 20140709133746.70d0dffb@notabene.brown (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

NeilBrown July 9, 2014, 3:37 a.m. UTC
I guess it should be obvious, but it never hurts to be explicit.
When the epoll file descriptor is closed all events are assumed
to be "processed".
Also if the event is removed with EPOLL_CTL_DEL or the EPOLLWAKEUP
flag is removed with EPOLL_CTL_MOD the event will be "processed".


Signed-off-by: NeilBrown <neilb@suse.de>

Comments

Michael Kerrisk (man-pages) July 9, 2014, 8:26 a.m. UTC | #1
Hi Neil,
On 07/09/2014 05:37 AM, NeilBrown wrote:
> 
> I guess it should be obvious, but it never hurts to be explicit.
> When the epoll file descriptor is closed all events are assumed
> to be "processed".
> Also if the event is removed with EPOLL_CTL_DEL or the EPOLLWAKEUP
> flag is removed with EPOLL_CTL_MOD the event will be "processed".

Thanks. Probably better to be explicit, as you say. Applied.

Cheers,

Michael


> Signed-off-by: NeilBrown <neilb@suse.de>
> 
> diff --git a/man2/epoll_ctl.2 b/man2/epoll_ctl.2
> index 2936bc7e97f7..74a09b6c276b 100644
> --- a/man2/epoll_ctl.2
> +++ b/man2/epoll_ctl.2
> @@ -173,7 +173,14 @@ until the next call to
>  .BR epoll_wait (2)
>  on the same
>  .BR epoll (7)
> -file descriptor.
> +file descriptor,
> +the closure of that file descriptor,
> +the removal of the event file descriptor with
> +.BR EPOLL_CTL_DEL ,
> +or the clearing of
> +.B EPOLLWAKEUP
> +for the event file descriptor with
> +.BR EPOLL_CTL_MOD .
>  See also BUGS.
>  .SH RETURN VALUE
>  When successful,
>
Rafael J. Wysocki July 9, 2014, 12:37 p.m. UTC | #2
On Wednesday, July 09, 2014 01:37:46 PM NeilBrown wrote:
> 
> --Sig_/BvtUQvnWLsVQBetw73gPkyQ
> Content-Type: text/plain; charset=US-ASCII
> Content-Transfer-Encoding: quoted-printable
> 
> 
> I guess it should be obvious, but it never hurts to be explicit.
> When the epoll file descriptor is closed all events are assumed
> to be "processed".
> Also if the event is removed with EPOLL_CTL_DEL or the EPOLLWAKEUP
> flag is removed with EPOLL_CTL_MOD the event will be "processed".
> 
> 
> Signed-off-by: NeilBrown <neilb@suse.de>

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> diff --git a/man2/epoll_ctl.2 b/man2/epoll_ctl.2
> index 2936bc7e97f7..74a09b6c276b 100644
> --- a/man2/epoll_ctl.2
> +++ b/man2/epoll_ctl.2
> @@ -173,7 +173,14 @@ until the next call to
>  .BR epoll_wait (2)
>  on the same
>  .BR epoll (7)
> -file descriptor.
> +file descriptor,
> +the closure of that file descriptor,
> +the removal of the event file descriptor with
> +.BR EPOLL_CTL_DEL ,
> +or the clearing of
> +.B EPOLLWAKEUP
> +for the event file descriptor with
> +.BR EPOLL_CTL_MOD .
>  See also BUGS.
>  .SH RETURN VALUE
>  When successful,
> 
> --Sig_/BvtUQvnWLsVQBetw73gPkyQ
> Content-Type: application/pgp-signature; name=signature.asc
> Content-Disposition: attachment; filename=signature.asc
> 
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v2.0.22 (GNU/Linux)
> 
> iQIVAwUBU7y5Cjnsnt1WYoG5AQJjuQ/+JshOD5nn4wRh83j+QK8Y1ff1Fynw2jh4
> vWGGdF/XdEyJgagnFuIuVHHmn0yyGvGYE8xFzgtBJqs12O6+7AshRUXtCSjr6f7r
> kwa4dZQvwDMr0SchoIsftexZJJPQOE7zxDwm7jjk7682/VoePbCtXHUnVUM3G6Hl
> 5n/11WDocetHFztj95lIF8KIQZ98Q7ZOETvdxnZXIvBtxxaPLVdOS/a7d8q2bcP3
> /rvM+JyA0SnUx3ZFTbqYWmUk/WWDjXhBEwt5fSqqph4zOT7sxjCH1kmap1MV4ej2
> ZzQ5rgecQDL+YAJTLYNKeDCeYpGQYVDNUK4oLq5ofsNLcump3jAlnUfmB96ifD7h
> iXxWExv9r1Zk3aS//ZRgFQuGas+w23wklEjaavwQFt9S0aoS6zmcsSWpucyvpYCW
> JOguVvqO4qphadh1gfOhWEpYVgD9AhADqICLymwcVAphYq/TenRqFPv7UdbcBE0l
> vDM5D8R0bLrcHLheA2YWwwxTDdZo49D08Pf7RopKbnoMxmwpoxRdkYiJ/n981wgR
> 4S3FQgSAD+wsI87kwkf0uU3YXT5IYrMt5VoaQZysDTC1ryPuHn4JPexw0YRDOd7l
> D+SSounos3jqMTVsmKolA84pSMmEcPwQ0624QHouWWkGVlcApIw2xDgr1c6TYzPq
> s/V/0SXPztU=
> =8PYy
> -----END PGP SIGNATURE-----
> 
> --Sig_/BvtUQvnWLsVQBetw73gPkyQ--
>
diff mbox

Patch

diff --git a/man2/epoll_ctl.2 b/man2/epoll_ctl.2
index 2936bc7e97f7..74a09b6c276b 100644
--- a/man2/epoll_ctl.2
+++ b/man2/epoll_ctl.2
@@ -173,7 +173,14 @@  until the next call to
 .BR epoll_wait (2)
 on the same
 .BR epoll (7)
-file descriptor.
+file descriptor,
+the closure of that file descriptor,
+the removal of the event file descriptor with
+.BR EPOLL_CTL_DEL ,
+or the clearing of
+.B EPOLLWAKEUP
+for the event file descriptor with
+.BR EPOLL_CTL_MOD .
 See also BUGS.
 .SH RETURN VALUE
 When successful,