mirrors/cosmopolitan
1
0
Fork 0
mirror of https://github.com/jart/cosmopolitan.git synced 2025-06-06 12:42:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Reformat libc README.md (#437)

Browse source
This commit is contained in:
Jules Bertholet 2022-06-21 10:50:42 -04:00 • committed by GitHub
parent ff28e38ef1
commit 4b23985b7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

20
libc/README.md
View file

@ -1,15 +1,11 @@
SYNOPSIS # Cosmopolitan Standard Library
Cosmopolitan Standard Library.
OVERVIEW
This directory defines static archives defining functions, like This directory defines static archives defining functions, like
printf(), mmap(), win32, etc. Please note that the Cosmopolitan `printf()`, `mmap()`, win32, etc. Please note that the Cosmopolitan
build configuration doesn't link any C/C++ library dependencies build configuration doesn't link any C/C++ library dependencies
by default, so you still have the flexibility to choose the one by default, so you still have the flexibility to choose the one
provided by your system. If you'd prefer Cosmopolitan, just add provided by your system. If you'd prefer Cosmopolitan, just add
$(LIBC) and $(CRT) to your linker arguments. `$(LIBC)` and `$(CRT)` to your linker arguments.
Your library is compromised of many bite-sized static archives. Your library is compromised of many bite-sized static archives.
We use the checkdeps tool to guarantee that the contents of the We use the checkdeps tool to guarantee that the contents of the
@ -20,8 +16,8 @@ OVERVIEW
The Cosmopolitan Library exports only the most stable canonical The Cosmopolitan Library exports only the most stable canonical
system calls for all supported operating systems, regardless of system calls for all supported operating systems, regardless of
which platform is used for compilation. We polyfill many of the which platform is used for compilation. We polyfill many of the
APIs, e.g. read(), write() so they work consistently everywhere APIs, e.g. `read()`, `write()` so they work consistently everywhere
while other apis, e.g. CreateWindowEx(), might only work on one while other apis, e.g. `CreateWindowEx()`, might only work on one
platform, in which case they become no-op functions on others. platform, in which case they become no-op functions on others.
Cosmopolitan polyfill wrappers will usually use the dollar sign Cosmopolitan polyfill wrappers will usually use the dollar sign
@ -31,11 +27,11 @@ OVERVIEW
allow Cosmopolitan to go fast on both old and newer computers. allow Cosmopolitan to go fast on both old and newer computers.
We take an approach to configuration that relies heavily on the We take an approach to configuration that relies heavily on the
compiler's dead code elimination pass (libc/dce.h). Most of the compiler's dead code elimination pass (`libc/dce.h`). Most of the
code is written so that, for example, folks not wanting support code is written so that, for example, folks not wanting support
for OpenBSD can flip a bit in SUPPORT_VECTOR and that code will for OpenBSD can flip a bit in `SUPPORT_VECTOR` and that code will
be omitted from the build. The same is true for builds that are be omitted from the build. The same is true for builds that are
tuned using -march=native which effectively asks the library to tuned using `-march=native` which effectively asks the library to
not include runtime support hooks for x86 processors older than not include runtime support hooks for x86 processors older than
what you use. what you use.