ossf
add documentation on how to write analysis plugin
At the moment it's unclear for someone new to the project how to write an analysis plugin. It would be nice with documentation and a tutorial on how to do this. Specific points to cover:
- where to place it
- which interface to use
- how to enable it
- what APIs fuzz introspector offers
@DavidKorczynski I think it would be great if it was also mentioned how stable the API is to make it easier to figure our out how likely it is bespoke plugins can break.
Just to clarify by bespoke plugins I meant plugins that are kept out of the fuzz-introspector repository.
Thanks @evverx -- I think realistically this issue will be closed when https://github.com/ossf/fuzz-introspector/issues/280 is done. The reason being the code base as is made a lot of assumptions based on the llvm/clang infrastructure when doing the initial work for FI, but these assumption turned out to not really be valid in the Python world. Once Python integration is better we'll have a better understanding on how to control handling various languages and at that point I think we'll settle on a more stable API