Changeset cde999a in mainline for kernel/generic/src

Timestamp:

2018-01-04T20:22:51Z (8 years ago)

Author:

Jiří Zárevúcky <zarevucky.jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

3d95c9d, 84a1a54

Parents:

3c7702c0

git-author:

Jiří Zárevúcky <zarevucky.jiri@…> (2018-01-04 19:18:29)

git-committer:

Jiří Zárevúcky <zarevucky.jiri@…> (2018-01-04 20:22:51)

Message:

Fix comments to stop referring to error codes as negative.

Location:

kernel/generic/src

Files:

• cap/cap.c (modified) (1 diff)
• debug/symtab.c (modified) (1 diff)
• ipc/ipc.c (modified) (1 diff)
• ipc/ipcrsc.c (modified) (1 diff)
• ipc/irq.c (modified) (1 diff)
• ipc/sysipc.c (modified) (3 diffs)
• proc/program.c (modified) (3 diffs)
• syscall/copy.c (modified) (2 diffs)
• udebug/udebug.c (modified) (1 diff)
• udebug/udebug_ops.c (modified) (2 diffs)

kernel/generic/src/cap/cap.c

@@ -259 +259 @@
  * @param[out] handle  New capability handle on success.
  *
- * @return Negative error code in case of error.
+ * @return An error code in case of error.
  */
 int cap_alloc(task_t *task, cap_handle_t *handle)

kernel/generic/src/debug/symtab.c

@@ -50 +50 @@
  * @param offset Place to store offset from the symbol address.
  *
- * @return Zero on success or negative error code, ENOENT if not found,
+ * @return Zero on success or an error code, ENOENT if not found,
  *         ENOTSUP if symbol table not available.
  *

kernel/generic/src/ipc/ipc.c

@@ -205 +205 @@
  * @param request Call structure with request.
  *
- * @return EOK on success or a negative error code.
+ * @return EOK on success or an error code.
  *
  */

kernel/generic/src/ipc/ipcrsc.c

@@ -168 +168 @@
  * @param[out] out_handle  New phone capability handle.
  *
- * @return  Negative error code if a new capability cannot be allocated.
+ * @return  An error code if a new capability cannot be allocated.
  */
 int phone_alloc(task_t *task, cap_handle_t *out_handle)

kernel/generic/src/ipc/irq.c

@@ -387 +387 @@
  * @param handle  IRQ capability handle.
  *
- * @return EOK on success or a negative error code.
+ * @return EOK on success or an error code.
  *
  */

kernel/generic/src/ipc/sysipc.c

@@ -155 +155 @@
  * @param olddata Saved data of the request.
  *
- * @return Return EOK on success or a negative error code.
+ * @return Return EOK on success or an error code.
  *
  */
@@ -359 +359 @@
  *
  * @return EOK on success.
- * @return Negative error code on error.
+ * @return An error code on error.
  *
  */
@@ -740 +740 @@
  *                 for explanation.
  *
- * @return Negative error code on error.
+ * @return An error code on error.
  */
 sysarg_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec,

kernel/generic/src/proc/program.c

@@ -66 +66 @@
  * @param prg        Buffer for storing program information.
  *
- * @return EOK on success or negative error code.
+ * @return EOK on success or an error code.
  *
  */
@@ -134 +134 @@
  *                        will be returned.
  *
- * @return EOK on success or negative error code.
+ * @return EOK on success or an error code.
  *
  */
@@ -171 +171 @@
  * @param name Name to set for the program's task.
  *
- * @return EOK on success or negative error code.
+ * @return EOK on success or an error code.
  *
  */

kernel/generic/src/syscall/copy.c

@@ -57 +57 @@
  * @param size Size of the data to be copied.
  *
- * @return EOK on success or error code from @ref errno.h.
+ * @return EOK on success or an error code from @ref errno.h.
  */
 int copy_from_uspace(void *dst, const void *uspace_src, size_t size)
@@ -108 +108 @@
  * @param size Size of the data to be copied.
  *
- * @return 0 on success or error code from @ref errno.h.
+ * @return 0 on success or an error code from @ref errno.h.
  */
 int copy_to_uspace(void *uspace_dst, const void *src, size_t size)

kernel/generic/src/udebug/udebug.c

@@ -394 +394 @@
  * @param task Task structure. task->udebug.lock must be already locked.
  *
- * @return Zero on success or negative error code.
+ * @return Zero on success or an error code.
  *
  */

kernel/generic/src/udebug/udebug_ops.c

@@ -216 +216 @@
  * Closes the debugging session for the current task.
  *
- * @return Zero on success or negative error code.
+ * @return Zero on success or an error code.
  *
  */
@@ -236 +236 @@
  * @param mask Or combination of events that should be enabled.
  *
- * @return Zero on success or negative error code.
+ * @return Zero on success or an error code.
  *
  */