Date: Wed, 18 Mar 1998 21:58:31 -0800 (PST) Message-Id: <199803190558.VAA19347@adit.ap.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=====================_890286953==_" To: djgpp-workers AT delorie DOT com, dj AT delorie DOT com From: Nate Eldredge Subject: Documentation fixes Precedence: bulk --=====================_890286953==_ Content-Type: text/plain; charset="us-ascii" I've been looking through the docs of the 2.02 alpha (980101) and found a few typos. Here's a patch which corrects them. The only thing I'm not totally sure about are several functions which said things like, "This returns a pointer to static data which is overridden by each call". I believe this should be "overwritten", although "overridden" may also be valid. Patches are included anyway. --=====================_890286953==_ Content-Type: text/plain; charset="us-ascii" *** src/libc/dpmi/api/2f_1680.tx~ Mon Jul 10 05:40:42 1995 --- src/libc/dpmi/api/2f_1680.txh Wed Mar 18 19:04:22 1998 *************** *** 4,10 **** @example #include ! int __dpmi_yield(void); @end example @subheading Description --- 4,10 ---- @example #include ! void __dpmi_yield(void); @end example @subheading Description *** src/libc/pc_hw/co80/conio.tx~ Sun Aug 31 20:13:18 1997 --- src/libc/pc_hw/co80/conio.txh Wed Mar 18 19:17:58 1998 *************** *** 537,543 **** @subheading Return Value ! zero on success. @c ---------------------------------------------------------------------- @node cscanf, conio --- 537,543 ---- @subheading Return Value ! Zero on success. @c ---------------------------------------------------------------------- @node cscanf, conio *** src/libc/crt0/crt0.tx~ Sun Aug 31 20:13:18 1997 --- src/libc/crt0/crt0.txh Wed Mar 18 19:30:02 1998 *************** *** 16,22 **** @subheading Return Value ! zero if the break was changed, -1 if not. @var{errno} is set to the error. @subheading Example --- 16,22 ---- @subheading Return Value ! Zero if the break was changed, -1 if not. @var{errno} is set to the error. @subheading Example *************** *** 44,50 **** can expand the heap (where @code{malloc} gets memory from) by increasing the break. ! This function is normally accessed only bu @code{malloc} (@pxref{malloc}). @subheading Return Value --- 44,50 ---- can expand the heap (where @code{malloc} gets memory from) by increasing the break. ! This function is normally accessed only by @code{malloc} (@pxref{malloc}). @subheading Return Value *** src/libc/ansi/time/ctime.tx~ Sun Aug 31 20:13:18 1997 --- src/libc/ansi/time/ctime.txh Wed Mar 18 17:30:44 1998 *************** *** 37,43 **** Sun Jan 01 12:34:56 1993\n\0 @end example ! The string pointed to is in a static buffer and will be overridden with each call to asctime. The data should be copied if it needs to be preserved. --- 37,43 ---- Sun Jan 01 12:34:56 1993\n\0 @end example ! The string pointed to is in a static buffer and will be overwritten with each call to asctime. The data should be copied if it needs to be preserved. *************** *** 87,93 **** @subheading Return Value ! A pointer to a static structure which is overridden with each call. @subheading Example --- 87,93 ---- @subheading Return Value ! A pointer to a static structure which is overwritten with each call. @subheading Example *************** *** 115,121 **** @subheading Return Value ! A pointer to a static structure which is overridden with each call. @c ---------------------------------------------------------------------- @node mktime, time --- 115,121 ---- @subheading Return Value ! A pointer to a static structure which is overwritten with each call. @c ---------------------------------------------------------------------- @node mktime, time *** src/libc/dpmi/api/d0002.tx~ Wed Jul 24 01:53:40 1996 --- src/libc/dpmi/api/d0002.txh Wed Mar 18 19:02:52 1998 *************** *** 4,10 **** @example #include ! int __dpmi_segment_to_descriptor @end example @subheading Description --- 4,10 ---- @example #include ! int __dpmi_segment_to_descriptor(int _segment); @end example @subheading Description *** src/libc/dpmi/api/d0503.tx~ Mon Jul 10 05:40:32 1995 --- src/libc/dpmi/api/d0503.txh Wed Mar 18 19:30:46 1998 *************** *** 4,10 **** @example #include ! int __dpmi_resize_memory @end example @subheading Description --- 4,10 ---- @example #include ! int __dpmi_resize_memory(__dpmi_meminfo *_info); @end example @subheading Description *** src/libc/ansi/stdio/fwalk.tx~ Sun Aug 31 20:13:18 1997 --- src/libc/ansi/stdio/fwalk.txh Wed Mar 18 19:10:46 1998 *************** *** 10,16 **** @subheading Description For each open file in the system, the given @var{function} is called, ! passing the file pointer as it's only argument @subheading Return Value --- 10,16 ---- @subheading Description For each open file in the system, the given @var{function} is called, ! passing the file pointer as it's only argument. @subheading Return Value *** src/libc/compat/stdlib/getlongp.tx~ Sun Jul 23 07:57:00 1995 --- src/libc/compat/stdlib/getlongp.txh Wed Mar 18 19:16:28 1998 *************** *** 18,25 **** @subheading Return Value ! Zero if successfull, -1 on error (and @var{errno} is set to and ! appropriate value. @subheading Example --- 18,25 ---- @subheading Return Value ! Zero if successful, -1 on error (and @var{errno} is set to an ! appropriate value). @subheading Example *** src/libc/go32/go32cbrk.tx~ Sun Jul 23 07:32:32 1995 --- src/libc/go32/go32cbrk.txh Wed Mar 18 19:23:08 1998 *************** *** 13,19 **** an exception or passed to the application. If you pass a nonzero value for @var{yes}, pressing @kbd{Ctrl-Break} will set a flag that can be detected with @code{_go32_was_ctrl_break_hit} ! (@pxref{_go32_was_ctrl_break_hit}). If you pass zero for @var{yes}, When you press @kbd{Ctrl-Break} the program will be terminated. Note that if you call @code{_go32_was_ctrl_break_hit}, this function --- 13,19 ---- an exception or passed to the application. If you pass a nonzero value for @var{yes}, pressing @kbd{Ctrl-Break} will set a flag that can be detected with @code{_go32_was_ctrl_break_hit} ! (@pxref{_go32_was_ctrl_break_hit}). If you pass zero for @var{yes}, when you press @kbd{Ctrl-Break} the program will be terminated. Note that if you call @code{_go32_was_ctrl_break_hit}, this function *** src/libc/go32/godefv1.tx~ Sun Jul 23 07:42:02 1995 --- src/libc/go32/godefv1.txh Wed Mar 18 19:22:38 1998 *************** *** 66,72 **** registers the function modifies are reflected in @var{regs} on return. If @code{SS} and @code{SP} are both zero, a small temporary stack is ! used when in real mode. If not, they are used AS IS. It's a good idea to use @code{memset} to initialize the register structure before using it. --- 66,72 ---- registers the function modifies are reflected in @var{regs} on return. If @code{SS} and @code{SP} are both zero, a small temporary stack is ! used when in real mode. If not, they are used @emph{as is}. It's a good idea to use @code{memset} to initialize the register structure before using it. *************** *** 107,113 **** in @var{regs} on return. If @code{SS} and @code{SP} are both zero, a small temporary stack is ! used when in real mode. If not, they are used AS IS. It's a good idea to use @code{memset} to initialize the register structure before using it. --- 107,113 ---- in @var{regs} on return. If @code{SS} and @code{SP} are both zero, a small temporary stack is ! used when in real mode. If not, they are used @emph{as is}. It's a good idea to use @code{memset} to initialize the register structure before using it. *************** *** 147,153 **** in @var{regs} on return. If @code{SS} and @code{SP} are both zero, a small temporary stack is ! used when in real mode. If not, they are used AS IS. It's a good idea to use @code{memset} to initialize the register structure before using it. --- 147,153 ---- in @var{regs} on return. If @code{SS} and @code{SP} are both zero, a small temporary stack is ! used when in real mode. If not, they are used @emph{as is}. It's a good idea to use @code{memset} to initialize the register structure before using it. *** src/libc/ansi/ctype/isalnum.tx~ Mon Jul 10 05:39:22 1995 --- src/libc/ansi/ctype/isalnum.txh Wed Mar 18 19:23:36 1998 *************** *** 16,20 **** Nonzero if @var{c} is a letter or digit, else zero. - @subheading Example --- 16,19 ---- *** src/libc/ansi/stdlib/ldiv.tx~ Mon Jul 10 05:39:56 1995 --- src/libc/ansi/stdlib/ldiv.txh Wed Mar 18 19:30:44 1998 *************** *** 4,16 **** @example #include ! ldiv_t ldiv(long numerator, long denomonator); @end example @subheading Description ! Returns the quotient and remainder of the division @var{numberator} ! divided by @var{denomonator}. The return type is as follows: @example typedef struct @{ --- 4,16 ---- @example #include ! ldiv_t ldiv(long numerator, long denominator); @end example @subheading Description ! Returns the quotient and remainder of the division @var{numerator} ! divided by @var{denominator}. The return type is as follows: @example typedef struct @{ *** src/libc/ansi/stdlib/lldiv.tx~ Mon May 20 18:13:02 1996 --- src/libc/ansi/stdlib/lldiv.txh Wed Mar 18 19:26:24 1998 *************** *** 4,16 **** @example #include ! lldiv_t lldiv(long long numerator, long long denomonator); @end example @subheading Description ! Returns the quotient and remainder of the division @var{numberator} ! divided by @var{denomonator}. The return type is as follows: @example typedef struct @{ --- 4,16 ---- @example #include ! lldiv_t lldiv(long long numerator, long long denominator); @end example @subheading Description ! Returns the quotient and remainder of the division @var{numerator} ! divided by @var{denominator}. The return type is as follows: @example typedef struct @{ *** src/libc/pc_hw/mem/md.tx~ Sat Apr 27 03:51:50 1996 --- src/libc/pc_hw/mem/md.txh Wed Mar 18 17:25:00 1998 *************** *** 19,25 **** @code{_dos_ds}) functions (@ref{_my_ds}, @ref{_go32_info_block}). The offsets are linear offsets. If the selector is for the program's data area, this offset corresponds to the address of a buffer (like ! @code{(int)&something}). If the selector is for the conventional memory area, the offset is the physical address of the memory, which can be computed from a traditional segment/offset pair as @code{segment}*16+@code{offset}. For example, the color text screen --- 19,25 ---- @code{_dos_ds}) functions (@ref{_my_ds}, @ref{_go32_info_block}). The offsets are linear offsets. If the selector is for the program's data area, this offset corresponds to the address of a buffer (like ! @code{(unsigned)&something}). If the selector is for the conventional memory area, the offset is the physical address of the memory, which can be computed from a traditional segment/offset pair as @code{segment}*16+@code{offset}. For example, the color text screen *************** *** 38,44 **** _dos_ds, 0xb8000, ScreenCols() * (ScreenRows()-1) * 2); /* fill last row */ ! movedata(_my_ds(), (int)blank_row_buf, _dos_ds, 0xb8000 + ScreenCols()*(ScreenRows()-1)*2, ScreenCols() * 2); @end example --- 38,44 ---- _dos_ds, 0xb8000, ScreenCols() * (ScreenRows()-1) * 2); /* fill last row */ ! movedata(_my_ds(), (unsigned)blank_row_buf, _dos_ds, 0xb8000 + ScreenCols()*(ScreenRows()-1)*2, ScreenCols() * 2); @end example *** src/libc/compat/stdio/mkstemp.tx~ Sun Jul 23 09:46:40 1995 --- src/libc/compat/stdio/mkstemp.txh Wed Mar 18 17:22:10 1998 *************** *** 25,30 **** @subheading Example @example ! int fd = mkstemp("/tmp/ccXXXXXX"); @end example --- 25,32 ---- @subheading Example @example ! int fd; ! char name[] = "/tmp/ccXXXXXX"); ! fd = mkstemp(name); @end example *** src/libc/posix/fcntl/open.tx~ Sat Apr 27 01:10:04 1996 --- src/libc/posix/fcntl/open.txh Wed Mar 18 19:27:34 1998 *************** *** 72,78 **** @item S_IRUSR ! The file is readable. This is always true for MS-DOS @item S_IWUSR --- 72,78 ---- @item S_IRUSR ! The file is readable. This is always true for MS-DOS. @item S_IWUSR *** src/libc/posix/dirent/readdir.tx~ Mon Jul 10 05:40:56 1995 --- src/libc/posix/dirent/readdir.txh Wed Mar 18 17:32:32 1998 *************** *** 22,28 **** @subheading Return Value ! A pointer to a static buffer that is overridden with each call. @subheading Example --- 22,28 ---- @subheading Return Value ! A pointer to a static buffer that is overwritten with each call. @subheading Example *** src/libc/compat/sys/resource/strlimit.tx~ Mon Sep 9 01:07:30 1996 --- src/libc/compat/sys/resource/strlimit.txh Wed Mar 18 19:28:24 1998 *************** *** 11,17 **** This function sets new limit pointed to by @var{rlimitp} on the resourece limit specified by @var{rltype}. Note that currently it ! always fail. @subheading Return Value --- 11,17 ---- This function sets new limit pointed to by @var{rlimitp} on the resourece limit specified by @var{rltype}. Note that currently it ! always fails. @subheading Return Value *** src/libc/ansi/string/strncmp.tx~ Mon Jul 10 05:40:04 1995 --- src/libc/ansi/string/strncmp.txh Wed Mar 18 19:30:38 1998 *************** *** 9,15 **** @subheading Description ! This function compares upto @var{max} characters of @var{s1} and @var{s2}. @subheading Return Value --- 9,15 ---- @subheading Description ! This function compares up to @var{max} characters of @var{s1} and @var{s2}. @subheading Return Value --=====================_890286953==_ Content-Type: text/plain; charset="us-ascii" Nate Eldredge eldredge AT ap DOT net --=====================_890286953==_--