[jdt-core-dev] Maintenance guide for the JDT index

[Stefan Xenos <sxenos@xxxxxxxxxx>]

TL;DR: I'd like to write a maintenance guide for the JDT index. Where should I put it and in what form?

While working on the new index, I've developed techniques for addressing the most common tasks:

- How do you benchmark the indexer?

- How do you find the cause of index corruption?

- How do you add new structures to the index?

- How can you test the index in a fragment state?

- How do you locate the problem if the content of the index doesn't match what's expected?

- How do you determine what's taking up the most space in the index?

- How do you test if an existing index is corrupt?

I was thinking of writing a guide describing the various processes I follow, to help others that may need to fix bugs with it in the future.

Where would the best place be to put such a guide? Since the folks on this list are the main audience for it, what form would you prefer to consume it in?

  - Stefan