diff --git a/src/docs/library_map.diviner b/src/docs/library_map.diviner new file mode 100644 index 0000000..3080d6c --- /dev/null +++ b/src/docs/library_map.diviner @@ -0,0 +1,20 @@ +@title Rebuilding the Library Map +@group working + +When you add or move classes or modules, you need to rebuild the Phutil library +map. + += Overview = + +Phutil libraries include a list of every symbol (class and function) defined +in them, and some other information like dependencies between symbols. This +map is generated by running the script: + + arcanist/scripts/phutil_mapper.php + +For instance, to regenerate the libphutil map itself, you'd run: + + libphutil/ $ ../arcanist/scripts/phutil_mapper.php src/ + +When you add new modules, remove modules, or move symbols around in existing +modules, you need to regenerate the map.