Set of exposed internal API is very wide. Impossible to guarantee stable API long term.

[hzeller]

On make install, a very large amount of headers is exported. This makes it impossible for internal refactorings to ever be possible as we've spilled all the implementation details externally, and Hyrum's law will make it impossible to change.

We have a single header that should specify the API for Surelog: Surelog/API/Surelog.h. However, now there are many headers that with there mere existence in an installation all give the impression to provide a stable API. We should strive to provide any user-visible stuff only in there or have a very limited set of includes that we actually export and are comfortable to keep stable long-term.

There is a kitchen-sink include that is exported (Surelog/surelog.h) which should only include the limited set of files we need to export (and eventually, we should eliminate this header as it is hard to reason what the users will actually use. IWYU!).

I suggest the following steps

1. figure out what actually needs to be visible (I suspect something like error reporting, symbolId, PathId, symbol table, command line parser, maybe a few more)
2. Look through these headers and make sure they don't accidentally rely on other things. Possibly cleanup.
3. Add a #warning in the surelog. h header to encourage people to include what they need (IWYU).
4. In a first step, reduce the amount of things included in surelog.h as determined in 1 and possibly user feedback.
5. reduce the number of header exported in an make install to the relevant ones and pledge to keep them backward compatible long-term

[timkpaine]

its crazy the number of separate install commands we do for header files in the cmake file as well.