andre/cosmopolitan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation

Browse Source 
The Cosmo API documentation page is pretty good now
https://justine.lol/cosmopolitan/documentation.html
This commit is contained in:
Justine Tunney
2020-12-27 07:02:35 -08:00
parent 13437dd19b
commit 1bc3a25505
367 changed files with 2542 additions and 26178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
libc/runtime/ftrace.greg.c
View File

@@ -19,7 +19,7 @@
╚─────────────────────────────────────────────────────────────────────────────*/
#include "libc/alg/bisectcarleft.internal.h"
#include "libc/bits/bits.h"
#include "libc/bits/safemacros.internal.h"
#include "libc/bits/safemacros.h"
#include "libc/calls/calls.h"
#include "libc/calls/internal.h"
#include "libc/calls/struct/sigset.h"
@@ -100,15 +100,14 @@ privileged interruptfn void ftrace_hook(void) {
}
/**
* Enables plaintext function tracing if --ftrace flag passed.
* Enables plaintext function tracing if `--ftrace` flag is passed.
*
* The --ftrace CLI arg is removed before main() is called. This
* code is intended for diagnostic purposes and assumes binaries
* are trustworthy and stack isn't corrupted. Logging plain text
* allows program structure to easily be visualized and hotspots
* identified w/ sed | sort | uniq -c | sort. A compressed trace
* can be made by appending --ftrace 2>&1 | gzip -4 >trace.gz to
* the CLI arguments. Have fun.
* The `--ftrace` CLI arg is removed before main() is called. This code
* is intended for diagnostic purposes and assumes binaries are
* trustworthy and stack isn't corrupted. Logging plain text allows
* program structure to easily be visualized and hotspots identified w/
* `sed | sort | uniq -c | sort`. A compressed trace can be made by
* appending `--ftrace 2>&1 | gzip -4 >trace.gz` to the CLI arguments.
*
* @see libc/runtime/_init.S for documentation
*/