From b988d4d3cb024420c6cb6cfeaa87a285b4680eed Mon Sep 17 00:00:00 2001 From: Scott Graham <scottmg@google.com> Date: Tue, 20 Nov 2018 09:38:16 -0800 Subject: [PATCH] [docs][rights] Update event docs on rights - Remove mentions of READ/WRITE - Refactor event to point to rights.md to create section on ZX_RIGHTS_BASIC ZX-2399 #comment Test: CQ Change-Id: Id245980d6074372dd41e1b05f845f2917d33b72c --- docs/rights.md | 8 ++++++++ docs/syscalls/event_create.md | 6 ++---- docs/syscalls/object_signal.md | 4 ---- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/rights.md b/docs/rights.md index c84514735bf..bfc79ff6c7e 100644 --- a/docs/rights.md +++ b/docs/rights.md @@ -35,6 +35,14 @@ default rights for each object type, which can be reduced via | **ZX_RIGHT_MANAGE_PROCESS** | **NOT YET IMPLEMENTED** Allows creation of threads, etc | | **ZX_RIGHT_MANAGE_THREAD** | **NOT YET IMPLEMENTED** Allows suspending/resuming threads, etc| +## ZX_RIGHTS_BASIC + +The basic rights allow primitive manipulation of handles and are common to the +majority of handle types by default. These are *ZX_RIGHT_DUPLICATE*, +*ZX_RIGHT_TRANSFER*, *ZX_RIGHT_WAIT*, and *ZX_RIGHT_INSPECT*. + +These four rights are referred to as *ZX_RIGHTS_BASIC* when used together. + ## See also [Objects](objects.md), [Handles](handles.md) diff --git a/docs/syscalls/event_create.md b/docs/syscalls/event_create.md index 424285671fe..ad9ba6163bd 100644 --- a/docs/syscalls/event_create.md +++ b/docs/syscalls/event_create.md @@ -18,12 +18,10 @@ zx_status_t zx_event_create(uint32_t options, zx_handle_t* out); is, its *ZX_USER_SIGNAL_n* (where *n* is 0 through 7) signals can be manipulated using **object_signal**(). -The newly-created handle will have the *ZX_RIGHT_TRANSFER*, *ZX_RIGHT_DUPLICATE*, -*ZX_RIGHT_READ*, *ZX_RIGHT_WRITE*, and *ZX_RIGHT_SIGNAL* rights. - ## RIGHTS -TODO(ZX-2399) +The newly-created handle will have the [basic rights](../rights.md#zx_rights_basic) +plus *ZX_RIGHT_SIGNAL*. ## RETURN VALUE diff --git a/docs/syscalls/object_signal.md b/docs/syscalls/object_signal.md index d141a78998a..2e5dc2fa75d 100644 --- a/docs/syscalls/object_signal.md +++ b/docs/syscalls/object_signal.md @@ -57,10 +57,6 @@ In the event of failure, a negative error value is returned. **ZX_ERR_PEER_CLOSED** **zx_object_signal_peer**() called on an object with a closed peer. -## NOTE - -*ZX_RIGHT_WRITE* is used to gate access to signal bits. This will likely change. - ## SEE ALSO [event_create](event_create.md), -- GitLab