diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-01-21 12:02:09 +0000 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-01-29 10:12:05 +0000 |
| commit | 5bfca3d329c19b0606c31bb288d41b58ca81ebb5 (patch) | |
| tree | af3fab4870e48cd7c570f957ed92a809393f5ae2 | |
| parent | bdad86e9c805a8cf978e19ed248f1864a67e3591 (diff) | |
doc: Clarify ssize_t use in coding guidelines
Change-Id: I083f673f37495d2e53c704a43a0892231b6eb281
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
| -rw-r--r-- | docs/coding-guidelines.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/coding-guidelines.rst b/docs/coding-guidelines.rst index 0fb23d96..3075c63d 100644 --- a/docs/coding-guidelines.rst +++ b/docs/coding-guidelines.rst @@ -107,7 +107,9 @@ type usage guidelines should be followed: - Use ``size_t`` when storing the ``sizeof()`` something. -- (Rarely) use ``ssize_t`` when returning ``sizeof()`` or error from a function. +- Use ``ssize_t`` when returning the ``sizeof()`` something from a function that + can also return an error code; the signed type allows for a negative return + code in case of error. This practice should be used sparingly. - Use ``u_register_t`` when it's important to store the contents of a register in its native size (32-bit in AArch32 and 64-bit in AArch64). This is not a |