search

facebookexperimental / object-introspection

Object Introspection (OI) enables on-demand, hierarchical profiling of objects in arbitrary C/C++ programs with no recompilation.
Apache License 2.0
158 stars 14 forks source link

OIL documentation #498

Open ruben-laso opened 2 months ago

ruben-laso commented 2 months ago

I've recently found the CppCon'23 conference about OI.

I wanted to use it in an academic project to have the exact memory footprint of some data structures. However, the lack of documentation has been a problem for me so far.

Are there any plans to update the docs? Are there any other tutorials/docs other than the official webpage? I'm particularly interested in using OI as a library.

tyroguru commented 1 month ago

@ruben-laso Thanks for your interest in OIL and double apologies from me on this.

Firstly, sorry for not getting around to replying to this issue. Secondly, regarding the state of OIL documentation in our GitHub repo(Object Introspection as a Library). OIL is very tightly integrated into our build systems within Meta as we codegen against the clang AST as a compilation phase - we do AOT compilation within Meta with OIL. Our story with the GitHub code is not as clean and we lack any form of tight integration.

I'm tagging @JakeHillion who wrote the majority of the OIL code but he may be intermittent as he is out until early August.

I know this is not helpful but we will try and get the OIL integration / documentation story sorted in the Autumn.