Skip to content

Commit 05b1b32

Browse files
jmalakjmalak
committed
update CRTL documentation
1 parent ace9a03 commit 05b1b32

25 files changed

+116
-94
lines changed

‎docs/doc/cg/cromable.gml

+3-3
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ calloc~b~b~b~b~b~b~b~b~b~b~b~b~b
237237
cgets~b~b~b~b~b~b~b~b~b~b~b~b~b~b
238238
chdir~b~b~b~b~b~b~b~b~b~b~b~b~b~b
239239
chmod~b~b~b~b~b~b~b~b~b~b~b~b~b~b
240-
chsize~b~b~b~b~b~b~b~b~b~b~b~b~b
240+
_chsize~b~b~b~b~b~b~b~b~b~b~b~b
241241
clearerr~b~b~b~b~b~b~b~b~b~b~b
242242
clock~b~b~b~b~b~b~b~b~b~b~b~b~b~b
243243
close~b~b~b~b~b~b~b~b~b~b~b~b~b~b
@@ -305,7 +305,7 @@ _fheapwalk~b~b~b~b~b~b~b~b~b
305305
fgetc~b~b~b~b~b~b~b~b~b~b~b~b~b~b
306306
fgetpos~b~b~b~b~b~b~b~b~b~b~b~b
307307
fgets~b~b~b~b~b~b~b~b~b~b~b~b~b~b
308-
filelength~b~b~b~b~b~b~b~b~b
308+
_filelength~b~b~b~b~b~b~b~b
309309
fileno~b~b~b~b~b~b~b~b~b~b~b~b~b
310310
flushall~b~b~b~b~b~b~b~b~b~b~b
311311
_fmalloc~b~b~b~b~b~b~b~b~b~b~b
@@ -383,7 +383,7 @@ sbrk~b~b~b~b~b~b~b~b~b~b~b~b~b~b~b
383383
scanf~b~b~b~b~b~b~b~b~b~b~b~b~b~b
384384
_searchenv~b~b~b~b~b~b~b~b~b
385385
setbuf~b~b~b~b~b~b~b~b~b~b~b~b~b
386-
setmode~b~b~b~b~b~b~b~b~b~b~b~b
386+
_setmode~b~b~b~b~b~b~b~b~b~b~b
387387
setvbuf~b~b~b~b~b~b~b~b~b~b~b~b
388388
signal~b~b~b~b~b~b~b~b~b~b~b~b~b
389389
sleep~b~b~b~b~b~b~b~b~b~b~b~b~b~b

‎docs/doc/lr/cmanmac.gml

+3-7
Original file line numberDiff line numberDiff line change
@@ -798,14 +798,10 @@ string versions of
798798
.dm deprec end
799799
.*
800800
.dm deprfunc begin
801-
.id &*2.
802-
function is identical to the
801+
The
803802
.id &*1.
804-
function.
805-
Use
803+
function is deprecated, use
806804
.reffunc &*2.
807-
instead of
808-
.id &*1.
809-
.period
805+
instead.
810806
.dm deprfunc end
811807
.*

‎docs/doc/lr/libfuns.gml

+5-5
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@
117117
.fnc _chmod chmod chmod.gml DOS WIN32
118118
.fnw _wchmod chmod chmod.gml DOS WIN32
119119
.fnc chown chown chown.gml QXO
120-
.fnc chsize chsize chsize.gml DOS QNX W WIN32
121120
.fnc _chsize chsize chsize.gml DOS WIN32
121+
.fnc chsize chsize chsize.gml DOS QNX W WIN32
122122
.fnc _clear87 _clear87 _clear87.gml DOS QNX W WIN32
123123
.fnc clearenv clearenv clearenv.gml DOS QNX W WIN32
124124
.fnc clearerr clearerr clearerr.gml DOS QNX W WIN32
@@ -249,8 +249,8 @@
249249
.fnc endservent endservent endsrven.gml DOS W WIN32
250250
.fnc _endthread _endthread _ethread.gml DOS QXO WIN32
251251
.fnc _endthreadex _endthread _ethread.gml DOS WIN32
252-
.fnc eof eof eof.gml DOS QNX W WIN32
253252
.fnc _eof eof eof.gml DOS WIN32
253+
.fnc eof eof eof.gml DOS QNX W WIN32
254254
.fnc erf erf erf.gml DOS QNX W WIN32
255255
.fnc erfc erfc erfc.gml DOS QNX W WIN32
256256
.fnc errno errno errno.gml QXO
@@ -331,9 +331,9 @@
331331
.fnc fgets fgets fgets.gml DOS QNX W WIN32
332332
.fnw fgetws fgets fgets.gml DOS QNX W WIN32
333333
.fn8 _fieeetomsbin _fieeetomsbin fieee2ms.gml DOS QNX W WIN32
334-
.fnc filelength filelength fileleng.gml DOS QNX W WIN32
335334
.fnc _filelength filelength fileleng.gml DOS WIN32
336335
.fn8 _filelengthi64 filelength fileleng.gml DOS WIN32
336+
.fnc filelength filelength fileleng.gml DOS QNX W WIN32
337337
.fnc FILENAME_MAX FILENAME_MAX filenmax.gml DOS QNX W WIN32
338338
.fnc fileno fileno fileno.gml DOS QNX W WIN32
339339
.fn7 _findclose _findclose findclos.gml DOS WIN32
@@ -1231,8 +1231,8 @@
12311231
.fnw _wsetlocale setlocale setlocal.gml DOS QNX W WIN32
12321232
.fnc _set_matherr _set_matherr _setmath.gml DOS QXO WIN32
12331233
.fnm _setmbcp _setmbcp setmbcp.gml DOS WIN32
1234-
.fnc setmode setmode setmode.gml DOS QNX W WIN32
12351234
.fnc _setmode setmode setmode.gml DOS WIN32
1235+
.fnc setmode setmode setmode.gml DOS QNX W WIN32
12361236
.fnc _setmx _setmx setmx.gml QXO
12371237
.fnc setnetent setnetent stnetent.gml DOS W WIN32
12381238
.fnc _set_new_handler set_new_handler setnew.gml DOS QNX W WIN32
@@ -1544,9 +1544,9 @@
15441544
.fnc tcsetattr tcsetattr tcsetatr.gml QXO
15451545
.fnc tcsetct tcsetct tcsetct.gml QXO
15461546
.fnc tcsetpgrp tcsetpgrp tcsetpgr.gml QXO
1547-
.fnc tell tell tell.gml DOS QNX W WIN32
15481547
.fnc _tell tell tell.gml DOS WIN32
15491548
.fn8 _telli64 tell tell.gml DOS WIN32
1549+
.fnc tell tell tell.gml DOS QNX W WIN32
15501550
.fn7 _tempnam _tempnam tempnam.gml DOS WIN32
15511551
.fnw _wtempnam _tempnam tempnam.gml DOS WIN32
15521552
.fnc term_attr_type term_attr_type att_type.trm QX40

‎docs/doc/lr/liblist7.gml

+5-5
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
.sys chmod DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
101101
.sys chown QNX16 QNX32 LNX32
102102
.sys chroot QNX16 QNX32 LNX32
103-
.sys _chsize DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232 RDOS
103+
.sys _chsize DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
104104
.sys chsize DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
105105
.sys _clear87 MATH
106106
.sys clearenv DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
@@ -245,7 +245,7 @@
245245
.sys _endthread WIN32 QNX32 OS216MT OS216DL OS232 LNX32 RDOS NET32
246246
.sys _endthreadex WIN32
247247
.sys environ NET32
248-
.sys _eof DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232 RDOS
248+
.sys _eof DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
249249
.sys eof DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
250250
.sys erf MATH
251251
.sys erfc MATH
@@ -324,7 +324,7 @@
324324
.sys _fheapshrink DOS16 WIN16 QNX16 OS216 OS216MT OS216DL
325325
.sys _fheapwalk DOS16 WIN16 QNX16 OS216 OS216MT OS216DL
326326
.sys _fieeetomsbin DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 NET32
327-
.sys _filelength DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232
327+
.sys _filelength DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
328328
.sys filelength DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
329329
.sys _filelengthi64 DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32
330330
.sys FILENAME_MAX MACRO
@@ -1341,8 +1341,8 @@
13411341
.sys setlogmask QNX16 QNX32
13421342
.sys _set_matherr MATH
13431343
.sys _setmbcp DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232 LNX32 RDOS
1344+
.sys _setmode DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
13441345
.sys setmode DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
1345-
.sys _setmode DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232 RDOS NET32
13461346
.sys setnetent LNX32
13471347
.sys set_new_handler DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 NET32
13481348
.sys _set_new_handler DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 NET32
@@ -1579,7 +1579,7 @@
15791579
.sys _tcsstr DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS
15801580
.sys _tcstok DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS
15811581
.sys _tcsupr DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS
1582-
.sys _tell DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232 RDOS
1582+
.sys _tell DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
15831583
.sys tell DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32 RDOS NET32
15841584
.sys _telli64 DOS16 DOS32 WIN16 WIN386 WIN32 QNX16 QNX32 OS216 OS216MT OS216DL OS232 LNX32
15851585
.sys _tempnam DOS16 DOS32 WIN16 WIN386 WIN32 OS216 OS216MT OS216DL OS232

‎docs/doc/lr/src/chsize.gml

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
.func chsize _chsize
1+
.func _chsize chsize
2+
.ansiname _chsize
23
.synop begin
34
#include <&iohdr>
4-
int chsize( int &fd, long size );
5-
.ixfunc2 '&DosFunc' &funcb
6-
.if &'length(&_func.) ne 0 .do begin
75
int _chsize( int &fd, long size );
8-
.ixfunc2 '&DosFunc' &_func
9-
.do end
6+
.ixfunc2 '&DosFunc' _chsize
7+
8+
.deprec
9+
int chsize( int &fd, long size );
10+
.ixfunc2 '&DosFunc' chsize
1011
.synop end
1112
.desc begin
1213
The
@@ -18,7 +19,6 @@ by extending or truncating the file to the length specified by
1819
.period
1920
If the file needs to be extended, the file is padded with NULL ('\0')
2021
characters.
21-
.im ansiconf
2222
.if '&machsys' eq 'QNX' .do begin
2323
.np
2424
Note that the
@@ -32,6 +32,8 @@ have been set by the
3232
.kw locking
3333
functions.
3434
.do end
35+
.np
36+
.deprfunc chsize _chsize
3537
.desc end
3638
.return begin
3739
The
@@ -59,7 +61,7 @@ Not enough space left on the device to extend the file.
5961
.endterm
6062
.error end
6163
.see begin
62-
.seelist chsize close creat open
64+
.seelist close creat open
6365
.see end
6466
.exmp begin
6567
#include <stdio.h>
@@ -74,7 +76,7 @@ void main()
7476
&fd = open( "file", O_RDWR | O_CREAT,
7577
S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP );
7678
if( &fd != -1 ) {
77-
if( chsize( &fd, 32 * 1024L ) != 0 ) {
79+
if( _chsize( &fd, 32 * 1024L ) != 0 ) {
7880
printf( "Error extending file\n" );
7981
}
8082
close( &fd );

‎docs/doc/lr/src/clibdos.gml

+1-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ library will remove carriage returns on input and add them on output,
250250
provided the mode is set to be
251251
.us text.
252252
This mode is set upon opening the file or with the
253-
.kw setmode
253+
.reffunc _setmode
254254
function.
255255
.*
256256
.section DOS Commands

‎docs/doc/lr/src/clibover.gml

+5-5
Original file line numberDiff line numberDiff line change
@@ -2340,7 +2340,7 @@ which is returned when the file is opened.
23402340
The file &handle is passed to the other functions.
23412341
.np
23422342
.fdbeg
2343-
.fd chsize
2343+
.fd _chsize
23442344
change the size of a file
23452345
.fd close
23462346
close file
@@ -2352,13 +2352,13 @@ create a file
23522352
duplicate file &handle, get unused &handle number
23532353
.fd dup2
23542354
duplicate file &handle, supply new &handle number
2355-
.fd eof
2355+
.fd _eof
23562356
test for end of file
23572357
.fd fcntl
23582358
control over an open file
23592359
.fd fdatasync
23602360
write queued file data to disk
2361-
.fd filelength
2361+
.fd _filelength
23622362
get file size
23632363
.fd fileno
23642364
get file &handle for stream file
@@ -2406,15 +2406,15 @@ read a symbolic link
24062406
read several records placing them into a specified number of buffers
24072407
.fd select
24082408
synchronous I/O multiplexing
2409-
.fd setmode
2409+
.fd _setmode
24102410
set file mode
24112411
.fd _sopen
24122412
open a file for shared access
24132413
.fd symlink
24142414
create a symbolic link
24152415
.fd sync
24162416
sync the filesystem
2417-
.fd tell
2417+
.fd _tell
24182418
get current file position
24192419
.fd umask
24202420
set file permission mask

‎docs/doc/lr/src/eof.gml

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
.func eof _eof
1+
.func _eof eof
2+
.ansiname _eof
23
.synop begin
34
#include <&iohdr>
4-
int eof( int &fd );
5-
.ixfunc2 '&OsIo' &funcb
6-
.if &'length(&_func.) ne 0 .do begin
75
int _eof( int &fd );
8-
.ixfunc2 '&OsIo' &_func
9-
.do end
6+
.ixfunc2 '&OsIo' _eof
7+
8+
.deprec
9+
int eof( int &fd );
10+
.ixfunc2 '&OsIo' eof
1011
.synop end
1112
.desc begin
1213
The
@@ -21,7 +22,8 @@ the
2122
.id &funcb.
2223
function may be called to detect the end of the file before
2324
an input operation beyond the end of the file is attempted.
24-
.im ansiconf
25+
.np
26+
.deprfunc eof _eof
2527
.desc end
2628
.return begin
2729
The
@@ -41,7 +43,7 @@ argument is not a valid file &handle..
4143
.endterm
4244
.error end
4345
.see begin
44-
.seelist eof read
46+
.seelist read
4547
.see end
4648
.exmp begin
4749
#include <stdio.h>
@@ -55,7 +57,7 @@ void main( void )
5557
.exmp break
5658
&fd = open( "file", O_RDONLY );
5759
if( &fd != -1 ) {
58-
while( ! eof( &fd ) ) {
60+
while( ! _eof( &fd ) ) {
5961
len = read( &fd, buffer, sizeof(buffer) - 1 );
6062
buffer[ len ] = '\0';
6163
printf( "%s", buffer );

‎docs/doc/lr/src/fileleng.gml

+12-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
.func filelength _filelength _filelengthi64
1+
.func _filelength _filelengthi64 filelength
2+
.ansiname _filelength
23
.synop begin
34
#include <&iohdr>
4-
long filelength( int &fd );
5-
.ixfunc2 '&OsIo' &funcb
6-
.if &'length(&_func.) ne 0 .do begin
75
long _filelength( int &fd );
8-
.ixfunc2 '&OsIo' &_func
9-
.do end
6+
.ixfunc2 '&OsIo' _filelength
107
__int64 _filelengthi64( int &fd );
11-
.ixfunc2 '&OsIo' &func64
8+
.ixfunc2 '&OsIo' _filelengthi64
9+
10+
.deprec
11+
long filelength( int &fd );
12+
.ixfunc2 '&OsIo' filelength
1213
.synop end
1314
.desc begin
1415
The
@@ -22,7 +23,8 @@ The &func64 function returns, as a 64-bit integer, the number of
2223
bytes in the opened file indicated by the file &handle
2324
.arg &fd
2425
.period
25-
.im ansiconf
26+
.np
27+
.deprfunc filelength _filelength
2628
.desc end
2729
.return begin
2830
If an error occurs in
@@ -36,7 +38,7 @@ If an error occurs in &func64, (&minus.1I64) is returned.
3638
Otherwise, the number of bytes written to the file is returned.
3739
.return end
3840
.see begin
39-
.seelist filelength fstat lseek tell
41+
.seelist fstat lseek _tell
4042
.see end
4143
.exmp begin
4244
#include <sys/types.h>
@@ -57,7 +59,7 @@ void main( void )
5759
.do end
5860
if( &fd != -1 ) {
5961
printf( "Size of file is %ld bytes\n",
60-
filelength( &fd ) );
62+
_filelength( &fd ) );
6163
close( &fd );
6264
}
6365
}

‎docs/doc/lr/src/lseek.gml

+4-4
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ not be supported in future versions of MS-DOS.
104104
The
105105
.id &funcb.
106106
function does not, in itself, extend the size of a file
107-
.seeref chsize
107+
.seeref _chsize
108108
.period
109109
.im ansiconf
110110
.np
@@ -119,8 +119,8 @@ The
119119
.id &funcb.
120120
function can be used to obtain the current file position
121121
(the
122-
.kw tell
123-
function is implemented in terms of &func).
122+
.reffunc _tell
123+
function is implemented in terms of &funcb).
124124
This value can then be used with the
125125
.id &funcb.
126126
function to reset the file
@@ -132,7 +132,7 @@ int &fd;
132132
/* get current file position */
133133
file_posn = lseek( &fd, 0L, SEEK_CUR );
134134
/* or */
135-
file_posn = tell( &fd );
135+
file_posn = _tell( &fd );
136136
137137
/* return to previous file position */
138138
file_posn = lseek( &fd, file_posn, SEEK_SET );

‎docs/doc/lr/src/mbsinit.gml

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ function determines whether
2020
the pointed-to
2121
.kw mbstate_t
2222
object describes an initial conversion state.
23+
.np
24+
.deprfunc sisinit mbsinit
2325
.desc end
2426
.*
2527
.return begin

0 commit comments

Comments
 (0)