Problem

pkg/truncindex - Documentation

Solution

All things in the pkg/ subdirectories are meant to be general purpose packages to be reused outside of Docker. The truncindex package provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id.

However, to be easily reused by another application, this package needs documentation. Add a README.md file in pkg/truncindex/ explaining the purpose of the package, and comment exported functions and types to make it easy to use.