diff options
| author | Giuliano Procida <gprocida@google.com> | 2023-11-10 12:30:01 +0000 |
|---|---|---|
| committer | Giuliano Procida <gprocida@google.com> | 2023-11-15 09:12:51 +0000 |
| commit | 69860abb87d8d5a42d622093dda617b290a64368 (patch) | |
| tree | 17b762ab62c312af8f000bd37374402f2623116d | |
| parent | 715d8f7557d0fbfb3b7a2685511c6aded67ea0f8 (diff) | |
| download | stg-69860abb87d8d5a42d622093dda617b290a64368.tar.gz | |
documentation: put all (in)stability notes in one place
This is also the first mention of native format versioning.
PiperOrigin-RevId: 581208797
Change-Id: Ib09fc82813ac8d3a69748764c54a2db5c09e63d8
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | doc/stg.md | 9 | ||||
| -rw-r--r-- | doc/stgdiff.md | 4 |
3 files changed, 8 insertions, 15 deletions
@@ -9,12 +9,18 @@ libabigail's XML format, BTF and ELF / DWARF. The ABI diff tool, `stgdiff`, supports multiple reporting options. +STG has a versioned native file format. Older formats can be read and +rewritten as the latest. + +NOTE: STG is under active developement. Tool arguments and behaviour are +subject to change. + ## Getting STG ### Distributions -We intend to package STG for major distributions. Currently we have packages as -follows: +We intend to package STG for major distributions. Currently we have +packages as follows: | *Distribution* | *Package* | | ---------------- | ----------------------------------------------------- | @@ -3,9 +3,6 @@ `stg` is used to extract and process ABI representations from libabigail XML, BTF and ELF/DWARF. -NOTE: This tool is a work in progress. Its arguments and behaviour are subject -to change at short notice. - ## Synopsis ``` @@ -59,14 +56,10 @@ The tool can be passed any number of inputs to combine into a unified ABI. Read ABI information from ELF symbols and DWARF types. - NOTE: C++ DWARF type support is a work in progress. - * `-s|--stg` Read ABI information from a `.stg` file. - NOTE: The `.stg` format is still novel and subject to change. - ### Options * `--types` @@ -165,8 +158,6 @@ nodes that are recursively equal. By default, duplicate nodes are eliminated. The output will be an ABI representation in STG's native format. - NOTE: The `.stg` format is still novel and subject to change. - ## Diagnostics * `-m|--metrics` diff --git a/doc/stgdiff.md b/doc/stgdiff.md index e79ad34..e91b0e4 100644 --- a/doc/stgdiff.md +++ b/doc/stgdiff.md @@ -51,14 +51,10 @@ ignore options: type_declaration_status symbol_type_presence primitive_type_enco Read ABI information from ELF symbols and DWARF types. - NOTE: C++ DWARF type support is a work-in-progress. - * `-s|--stg` Read ABI information from a `.stg` file. - NOTE: The `.stg` format is still novel and subject to change. - ### Options * `--types` |