xref: /aosp_15_r20/external/stg/doc/index.md (revision 9e3b08ae94a55201065475453d799e8b1378bea6)
1# Documentation
2
3First-time users should start with the [tutorial](tutorial.md).
4
5## Manual Pages
6
7These describe all the various command line options.
8
9*   [`stg`](stg.md): ABI extraction and transformation
10*   [`stgdiff`](stgdiff.md): ABI comparison and reporting
11
12## Reference
13
14*   [`reference`](reference.md): work-in-progress covering concepts etc.
15
16## Design and Implementation
17
18Incomplete descriptions of some of the more interesting things that make up
19`stgdiff`.
20
21*   [Comparison](comparison.md): how STG compares graphs
22*   [Naming](naming.md): how STG builds C type name syntax
23*   [Reporting](reporting.md): how STG serialises reports
24*   [SCC](scc.md): how STG efficiently and safely handles cyclic graphs
25