[PATCH] D118514: [doc] Add llvm-ifs commandline guide

[Petr Hosek via Phabricator via llvm-commits]

phosek added inline comments.


================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:17-20
+stubs is useful for monitoring ABI changes of the shared object. The linkable
+shared object stubs, on the other hand, are significantly smaller than stripped
+shared objects. This can reduce the sizes of certain SDK packages that distribute
+link only shared objects.
----------------
Consider this.


================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:27
+Here is an example of the text representation (IFS) of a shared object produced
+by the llvm-ifs:
+
----------------



================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:46
+
+* IFSVersion: Version of the IFS file for reader compatibility.
+
----------------
I'd format these as code.


================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:72-75
+linkable ELF shared object as well as an Apple TAPI format file. The ordering
+of the Symbols are sorted, so it can be easily monitored by diff tools. If
+anything changed in this file, it indicates that change is an ABI breaking
+change and should raise concerns.
----------------



================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:87
+
+* Dynamic symbol table (.dynsym section).
+
----------------
These should be formatted as code.


================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:106
+This ELF file may have compatibility issues with ELF analysis tools that rely on the program headers.
+But it is guaranteed that linkers like LLD work fine with this minimum ELF file without errors.
+
----------------
I'm not sure if it's guaranteed, but we've confirmed it to be the case.


================
Comment at: llvm/docs/CommandGuide/llvm-ifs.rst:132
+ This flag is optional and it should only be used when reading an IFS file
+ which does not define the Arch (architecture). This flag defines the
+ architecture of the output file, and can be any string supported by ELF
----------------
This should be formatted as code, the same for other fields below.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D118514/new/

https://reviews.llvm.org/D118514