|
578 | 578 | "*PATH"
|
579 | 579 | ]
|
580 | 580 |
|
581 |
| -# Much like `env_var_separators` and companion to `shell_pathed_env_vars`, this |
582 |
| -# setting provides control over separators for list-like env vars on a per-shell |
| 581 | +# Much like :data:`env_var_separators` and companion to :data:`shell_pathed_env_vars`, |
| 582 | +# this setting provides control over separators for list-like env vars on a per-shell |
583 | 583 | # basis. Each shell has it's own pathsep but this provides more explicit control
|
584 | 584 | # and flexibility.
|
585 | 585 | shell_env_var_separators = {
|
|
590 | 590 | }
|
591 | 591 |
|
592 | 592 | # Some shells may require finer grained control over how path variables are
|
593 |
| -# handled. Similar to `pathed_env_vars`, this option provides a way to define |
| 593 | +# handled. Similar to :data:`pathed_env_vars`, this option provides a way to define |
594 | 594 | # variables the shell should handle, but on a per-shell basis. This setting can
|
595 |
| -# be used in addition to the platform pathing strategy provided by `pathed_env_vars` |
596 |
| -# to override or disable it if that is desired. |
| 595 | +# be used in addition to the platform pathing strategy provided by |
| 596 | +# :data:`pathed_env_vars` to override or disable it if that is desired. |
597 | 597 | #
|
598 | 598 | # A path-like variable defined in this setting should correspond to a pathsep
|
599 |
| -# setting in either `env_var_separators` or `shell_env_var_separators`. It can be |
600 |
| -# both, but only one is necessary. A corresponding pathsep setting informs the shell |
601 |
| -# plugin how to join paths of that type. |
| 599 | +# setting in either :data:`env_var_separators` or :data:`shell_env_var_separators`. |
| 600 | +# It can be both, but only one is necessary. A corresponding pathsep setting informs |
| 601 | +# the shell plugin how to join paths of that type. |
602 | 602 | #
|
603 |
| -# Note that, similar to `pathed_env_vars`, wildcards are supported. |
| 603 | +# Note that, similar to :data:`pathed_env_vars`, wildcards are supported. |
604 | 604 | shell_pathed_env_vars = {
|
605 | 605 | "gitbash": [
|
606 | 606 | "PYTHONPATH",
|
|
609 | 609 | }
|
610 | 610 |
|
611 | 611 | # Global toggle to perform path normalization to path-like environment variables.
|
612 |
| -# Applies the `pathed_env_vars` and `shell_pathed_env_vars` setting to all shells. |
613 |
| -# If `shell_pathed_env_vars` setting is configured then it overrides `pathed_env_vars` |
614 |
| -# if the keys are the same. Setting this to `False` disables all normalization. |
| 612 | +# Applies the :data:`pathed_env_vars` and :data:`shell_pathed_env_vars` setting to all |
| 613 | +# shells. If :data:`shell_pathed_env_vars` setting is configured then it overrides |
| 614 | +# :data:`pathed_env_vars` if the keys are the same. Setting this to ``False`` disables |
| 615 | +# all normalization. |
615 | 616 | enable_path_normalization = False
|
616 | 617 |
|
617 | 618 | # Defines what suites on ``$PATH`` stay visible when a new rez environment is resolved.
|
|
0 commit comments