This is an archive of the discontinued LLVM Phabricator instance.

Differential D145633

[libc][docs] update list of completed stdio funcs
ClosedPublic

Authored by michaelrj on Mar 8 2023, 4:40 PM.

Details

Reviewers
sivachandra
lntue
Commits
rG08df6c78b57c: [libc][docs] update list of completed stdio funcs

Diff Detail

Event Timeline

michaelrj created this revision.Mar 8 2023, 4:40 PM
Herald added projects: Restricted Project, Restricted Project. · View Herald TranscriptMar 8 2023, 4:40 PM
Herald added subscribers: libc-commits, ecnelises, tschuett. · View Herald Transcript
michaelrj requested review of this revision.Mar 8 2023, 4:40 PM
Harbormaster completed remote builds in B218247: Diff 503564.Mar 8 2023, 5:06 PM
lntue accepted this revision.Mar 8 2023, 5:17 PM
This revision is now accepted and ready to land.Mar 8 2023, 5:17 PM
Closed by commit rG08df6c78b57c: [libc][docs] update list of completed stdio funcs (authored by michaelrj). · Explain WhyMar 9 2023, 10:45 AM
This revision was automatically updated to reflect the committed changes.
michaelrj added a commit: rG08df6c78b57c: [libc][docs] update list of completed stdio funcs.

Revision Contents

PathSize
libc/
docs/
26 lines

Diff 503564

libc/docs/stdio.rst

Show All 17 Lines
Formatted Input/Output Functions Formatted Input/Output Functions
================================ ================================
These functions take in format strings and arguments of various types and These functions take in format strings and arguments of various types and
convert either to or from those arguments. These functions are the current focus convert either to or from those arguments. These functions are the current focus
(owner: michaelrj). (owner: michaelrj).
============= ========= ============= =========
Function_Name Available Function Name Available
============= ========= ============= =========
\*printf WIP \*printf Mostly
\*scanf \*scanf |check|
============= ========= ============= =========
``FILE`` Access ``FILE`` Access
=============== ===============
These functions are used to interact with the ``FILE`` object type, which is an These functions are used to interact with the ``FILE`` object type, which is an
I/O stream, often used to represent a file on the host's hard drive. Currently I/O stream, often used to represent a file on the host's hard drive. Currently
the ``FILE`` object is only available on linux. the ``FILE`` object is only available on linux.
============= ========= ============= =========
Function_Name Available Function Name Available
============= ========= ============= =========
fopen |check| fopen |check|
freopen freopen
fclose |check| fclose |check|
fflush |check| fflush |check|
setbuf setbuf |check|
setvbuf setvbuf |check|
ftell ftell |check|
fgetpos fgetpos
fseek |check| fseek |check|
fsetpos fsetpos
rewind rewind
tmpfile tmpfile
clearerr |check| clearerr |check|
feof |check| feof |check|
ferror |check| ferror |check|
Show All 17 Lines
Unformatted ``FILE`` Input/Output Functions Unformatted ``FILE`` Input/Output Functions
=========================================== ===========================================
The ``gets`` function was removed in C11 for having no bounds checking and The ``gets`` function was removed in C11 for having no bounds checking and
therefor being impossible to use safely. therefor being impossible to use safely.
============= ========= ============= =========
Function_Name Available Function Name Available
============= ========= ============= =========
(f)getc (f)getc |check|
fgets fgets |check|
getchar getchar
fread |check| fread |check|
(f)putc (f)putc |check|
(f)puts |check| (f)puts |check|
putchar putchar |check|
fwrite |check| fwrite |check|
ungetc ungetc |check|
============= ========= ============= =========