From 276686afea06e0b4fec6fead04bd20ec899654d7 Mon Sep 17 00:00:00 2001 From: neil Date: Mon, 7 Oct 2013 14:30:43 +0000 Subject: [PATCH] Improvements to AutoDocs, typo fixes etc. git-svn-id: https://svn.aros.org/svn/aros/trunk/AROS@48224 fb15a70f-31f2-0310-bbcc-cdcc74a49acc --- compiler/include/intuition/screens.h | 2 +- compiler/posixc/__vfork.c | 58 ++++++++++++---------- rom/dos/close.c | 6 +-- rom/exec/deletepool.c | 7 +-- rom/intuition/setattrsa.c | 4 +- workbench/libs/gallium/createpipescreen.c | 12 ++--- .../state_trackers/arosmesa/arosmesa_types.h | 2 +- workbench/libs/muimaster/macros.h | 7 +-- 8 files changed, 51 insertions(+), 47 deletions(-) diff --git a/compiler/include/intuition/screens.h b/compiler/include/intuition/screens.h index a3031572f6..91dcbce46f 100644 --- a/compiler/include/intuition/screens.h +++ b/compiler/include/intuition/screens.h @@ -343,4 +343,4 @@ struct DrawInfo #define OSERR_ATTACHFAIL 8 #define OSERR_NOTAVAILABLE 9 -#endif /* GRAPHICS_SCREENS_H */ +#endif /* INTUITION_SCREENS_H */ diff --git a/compiler/posixc/__vfork.c b/compiler/posixc/__vfork.c index 7fda998427..d25945f128 100644 --- a/compiler/posixc/__vfork.c +++ b/compiler/posixc/__vfork.c @@ -41,28 +41,31 @@ void) FUNCTION - Function to create a subprocess of the current process. + Function to create a subprocess of the current process. + This is there to ease porting of software using the fork()/vfork() - POSIX functions. Due to different memory and process model fork() + POSIX functions. Due to a different memory and process model, fork() is not implemented at the moment in the C library. vfork() is provided - with some extenden functionality. In POSIX standard the only guaranteed - functionality for vfork() is to have a exec*() function or _exit() called - right after the vfork() in the child. + with some extended functionality. In the POSIX standard the only + guaranteed functionality for vfork() is to have an exec*() function or + exit() called right after the vfork() in the child. + Extra functionality for vfork(): - - The child has it's own memory heap, memory allocation/deallocation - is allowed and heap will be removed when calling _exit() or will be used - for the code started by the exec*() functions. - - The child will have a copy of the file descriptors as specified by POSIX - standard for the fork() function. File I/O is possible in child, also - file manipulation with dup() etc. + - The child has its own memory heap; memory allocation/deallocation + is allowed and the heap will be removed when calling _exit() or will + be used for the code started by the exec*() functions. + - The child will have a copy of the file descriptors as specified by + the POSIX standard for the fork() function. File I/O is possible in + the child, as is file manipulation with dup() etc. Difference with fork(): - The virtual memory heap is not duplicated as in POSIX but the memory - is shared between parent and child. AROS lives in one big single memory - region so changes to memory in child are also seen by parent. + is shared between parent and child. AROS lives in one big single + memory region so changes to memory in the child are also seen by the + parent. - Behaviour for other resources not described in this doc may not be relied - on for future. + Behaviour for other resources not described in this doc may not be + relied on for future compatibility. INPUTS - @@ -74,9 +77,10 @@ NOTES Current implementation of vfork() will only really start running things - in parallel on an exec*() call. After vfork() child code will run until - _exit() or exec*(). With _exit() child will exit and parent continue; - with exec*() child will be detached and parent will continue. + in parallel on an exec*() call. After vfork(), child code will run until + _exit() or exec*(). With _exit(), the child will exit and the parent + will continue; with exec*(), the child will be detached and the parent + will continue. EXAMPLE @@ -89,13 +93,13 @@ ******************************************************************************/ -/* The following functions are used to update the childs and parents privdata +/* The following functions are used to update the child's and parent's privdata for the parent pretending to be running as child and for the child to take over. It is called in the following sequence: - parent_enterpretendchild() is called in vfork so the parent pretends to be - running as child child_takeover() is called by child if exec*() so it can - continue from the parent state parent_leavepretendchild() is called by parent - to switch back to be running as parent + parent_enterpretendchild() is called in vfork() so the parent pretends to be + running as child; child_takeover() is called by child if exec*() so it can + continue from the parent state; parent_leavepretendchild() is called by + parent to switch back to be running as parent */ static void parent_enterpretendchild(struct vfork_data *udata); static void child_takeover(struct vfork_data *udata); @@ -126,7 +130,7 @@ LONG launcher() return -1; } - /* TODO: Can we avoid opening posixc.library for child process ? */ + /* TODO: Can we avoid opening posixc.library for child process? */ PosixCBase = (struct PosixCIntBase *)OpenLibrary((STRPTR) "posixc.library", 0); if (PosixCBase) { @@ -398,12 +402,12 @@ pid_t __vfork(jmp_buf env) * The sole purpose of this function is to enable control over allocation of dummy and env. * Previously they were allocated in the ending code of __vfork function. On ARM however * this was causing immediate allocation of space at entry to the __vfork function. Moreover - * the jmp_buf is alligned(16) and as such is represeted on the stack as a pointer to stack + * the jmp_buf is aligned(16) and as such is represented on the stack as a pointer to stack * region instead of offset from stack base. * - * The exit block of __vfork function reprents a code that underwent a number of longjumps. The + * The exit block of __vfork function represents code that underwent a number of longjumps. The * stack there is not guaranteed to be preserved, thus the on-stack pointer representing dummy - * and evn were also damaged. Extracting the code below allows to control when the variables + * and env were also damaged. Extracting the code below allows to control when the variables * are allocated (as long as the function remains not inlined). */ static __attribute__((noinline)) void __vfork_exit_controlled_stack(struct vfork_data *udata) diff --git a/rom/dos/close.c b/rom/dos/close.c index a1b9bd0d8c..aa2a8641a8 100644 --- a/rom/dos/close.c +++ b/rom/dos/close.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2013, The AROS Development Team. All rights reserved. $Id$ Desc: @@ -28,8 +28,8 @@ /* FUNCTION Close a filehandle opened with Open(). If the file was used - with buffered I/O the final write may fail and thus Close() - return an error. The file is closed in any case. + with buffered I/O, the final write may fail and thus Close() + may return an error. The file is closed in any case. INPUTS file -- filehandle diff --git a/rom/exec/deletepool.c b/rom/exec/deletepool.c index abb5fd06cf..a690dc85a4 100644 --- a/rom/exec/deletepool.c +++ b/rom/exec/deletepool.c @@ -1,5 +1,5 @@ /* - Copyright � 1995-2011, The AROS Development Team. All rights reserved. + Copyright � 1995-2013, The AROS Development Team. All rights reserved. $Id$ Desc: Delete a memory pool including all its memory. @@ -29,7 +29,7 @@ struct ExecBase *, SysBase, 117, Exec) /* FUNCTION - Delete a pool including all it's memory. + Delete a pool including all its memory. INPUTS poolHeader - The pool allocated with CreatePool() or NULL. @@ -43,7 +43,8 @@ BUGS SEE ALSO - CreatePool(), AllocPooled(), FreePooled() + CreatePool(), AllocPooled(), FreePooled(), AllocVecPooled(), + FreeVecPooled() INTERNALS diff --git a/rom/intuition/setattrsa.c b/rom/intuition/setattrsa.c index 231966e7c4..e38811b3cf 100644 --- a/rom/intuition/setattrsa.c +++ b/rom/intuition/setattrsa.c @@ -1,5 +1,5 @@ /* - Copyright © 1995-2011, The AROS Development Team. All rights reserved. + Copyright © 1995-2013, The AROS Development Team. All rights reserved. Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved. $Id$ */ @@ -32,7 +32,7 @@ tagList - This is a list of attribute/value-pairs RESULT - Depends in the class. For gadgets, this value is non-zero if + Depends on the class. For gadgets, this value is non-zero if they need redrawing after the values have changed. Other classes will define other return values. diff --git a/workbench/libs/gallium/createpipescreen.c b/workbench/libs/gallium/createpipescreen.c index 25ee686fd9..b934701592 100644 --- a/workbench/libs/gallium/createpipescreen.c +++ b/workbench/libs/gallium/createpipescreen.c @@ -1,5 +1,5 @@ /* - Copyright 2010, The AROS Development Team. All rights reserved. + Copyright © 2010-2013, The AROS Development Team. All rights reserved. $Id$ */ @@ -24,10 +24,10 @@ /* FUNCTION Creates a gallium pipe screen. - + INPUTS tags - a pointer to tags to be used during creation. - + TAGS CPS_GalliumInterfaceVersion - Indicates a version of gallium interface that a client is expected to receive. The client expected version @@ -38,14 +38,12 @@ See also CreatePipeScreenV. RESULT - A valid pipe screen instance or NULL of creation was not succesfull. - + A valid pipe screen instance or NULL if creation was not successful. + BUGS INTERNALS - HISTORY - *****************************************************************************/ { AROS_LIBFUNC_INIT diff --git a/workbench/libs/mesa/src/gallium/state_trackers/arosmesa/arosmesa_types.h b/workbench/libs/mesa/src/gallium/state_trackers/arosmesa/arosmesa_types.h index 21cbc9d31b..ebc9721d06 100644 --- a/workbench/libs/mesa/src/gallium/state_trackers/arosmesa/arosmesa_types.h +++ b/workbench/libs/mesa/src/gallium/state_trackers/arosmesa/arosmesa_types.h @@ -50,4 +50,4 @@ struct arosmesa_context /* GL API for state tracker */ extern struct st_api * glstapi; -#endif /* AROSMESA_INTERNAL_H */ +#endif /* AROSMESA_TYPES_H */ diff --git a/workbench/libs/muimaster/macros.h b/workbench/libs/muimaster/macros.h index f171dc74ae..aecfae4e87 100644 --- a/workbench/libs/muimaster/macros.h +++ b/workbench/libs/muimaster/macros.h @@ -2,7 +2,7 @@ #define _MUI_MACROS_H /* - Copyright © 2002-2007, The AROS Development Team. All rights reserved. + Copyright © 2002-2013, The AROS Development Team. All rights reserved. $Id$ Macros available in original MUI and also some additional ones. @@ -231,7 +231,7 @@ Use them for example in a group containing 2 columns, in the first columns the label and in the second columns the object. - These objects should be uses because the user might have set strange + These objects should be used because the user might have set strange values. xxxLabel() is suited for Objects without frame @@ -381,7 +381,8 @@ #endif /* __cplusplus */ -/* We need the notify and area Instace Data at least here, but this stuff should be placed at the button anywhy */ +/* We need the notify and area Instance Data at least here, but this stuff + * should be placed at the button anyway */ #ifndef _MUI_CLASSES_NOTIFY_H #include "classes/notify.h" #endif -- 2.11.4.GIT