Thomas Kluyver avatar Thomas Kluyver committed 6a52e51

Clarify (hopefully) the documentation for the replace-paths option

Comments (0)

Files changed (1)

doc/distutils.rst

 | namespace-packages    | comma separated list of packages to be treated as   |
 |                       | namespace packages (path is extended using pkgutil) |
 +-----------------------+-----------------------------------------------------+
-| replace-paths         | comma separated list of paths to replace in modules |
-|                       | in the form <search>=<replace>, using the value *   |
-|                       | in the search portion of the directive will cause   |
-|                       | all paths not mentioned by any other directive to   |
-|                       | be replaced with the replacement value              |
+| replace-paths         | Modify filenames attached to code objects, which    |
+|                       | appear in tracebacks. Pass a comma separated list of|
+|                       | paths in the form <search>=<replace>. The value *   |
+|                       | in the search portion will match the directory      |
+|                       | containing the entire package, leaving just the     |
+|                       | relative path to the module.                        |
 +-----------------------+-----------------------------------------------------+
 | path                  | comma separated list of paths to search; the        |
 |                       | default value is sys.path                           |
 | packages              | list of names of packages to include, including all |
 |                       | of the package's submodules                         |
 +-----------------------+-----------------------------------------------------+
-| replacePaths          | list of 2-tuples containing search values and       |
-|                       | replacement values for paths of modules that are    |
-|                       | included; a search value of "*" will cause all      |
-|                       | paths not otherwise specified to be replaced with   |
-|                       | that directive's replacement value                  |
+| replacePaths          | Modify filenames attached to code objects, which    |
+|                       | appear in tracebacks. Pass a list of 2-tuples       |
+|                       | containing paths to search for and corresponding    |
+|                       | replacement values. A search for '*' will match the |
+|                       | directory containing the entire package, leaving    |
+|                       | just the relative path to the module.               |
 +-----------------------+-----------------------------------------------------+
 | compress              | boolean value indicating if the module bytecode     |
 |                       | should be compressed or not                         |
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.