next up previous contents
Next: 11. Extending the tool Up: 10. Files Previous: 10.1 Time stamps   Contents


10.2 Index files

CM can optionally generate a human-readable index file for each description file. An index files alphabetically lists all symbols defined or imported within the given library or library component. Index-file generation is normally disabled. To enable it, CM.Control.generate_index must be set to true (see section 4.1).

With index-file generation enabled, index files will be written for all description files involved every time CM performs a dependency analysis. (In other words, it is a side-effect to other CM operations such as CM.make etc.) If the name of the description files is $p$/$d$.cm, then the corresponding index file will be in $p$/CM/INDEX/$d$.cm.


Matthias Blume
2001-07-19