Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify docs for default_prefix and friends #750

Merged
merged 3 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions CONSTRUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,20 +500,22 @@ _required:_ no<br/>
_type:_ string<br/>

Set default install prefix. On Linux, if not provided, the default prefix
is `${HOME}/${NAME}` (or, if `HOME` is not set, `/opt/${NAME}`). On Windows,
is `${HOME}/<NAME>` (or, if `HOME` is not set, `/opt/<NAME>`). On Windows,
this is used only for "Just Me" installation; for "All Users" installation,
use the `default_prefix_all_users` key. If not provided, the default prefix
is `${USERPROFILE}\${NAME}`.
is `%USERPROFILE%\<NAME>`. Environment variables will be expanded at
installation time.

### `default_prefix_domain_user`

_required:_ no<br/>
_type:_ string<br/>

Set default installation prefix for domain user. If not provided, the
installation prefix for domain user will be `${LOCALAPPDATA}\${NAME}`.
installation prefix for domain user will be `%LOCALAPPDATA%\<NAME>`.
By default, it is different from the `default_prefix` value to avoid installing
the distribution in the roaming profile. Windows only.
the distribution in the roaming profile. Environment variables will be expanded
at installation time. Windows only.

### `default_prefix_all_users`

Expand All @@ -522,7 +524,8 @@ _type:_ string<br/>

Set default installation prefix for All Users installation. If not provided,
the installation prefix for all users installation will be
`${ALLUSERSPROFILE}\${NAME}`. Windows only.
`%ALLUSERSPROFILE%\<NAME>`. Environment variables will be expanded at installation
time. Windows only.

### `default_location_pkg`

Expand Down
13 changes: 8 additions & 5 deletions constructor/construct.py
Original file line number Diff line number Diff line change
Expand Up @@ -366,23 +366,26 @@

('default_prefix', False, str, r'''
Set default install prefix. On Linux, if not provided, the default prefix
is `${HOME}/${NAME}` (or, if `HOME` is not set, `/opt/${NAME}`). On Windows,
is `${HOME}/<NAME>` (or, if `HOME` is not set, `/opt/<NAME>`). On Windows,
this is used only for "Just Me" installation; for "All Users" installation,
use the `default_prefix_all_users` key. If not provided, the default prefix
is `${USERPROFILE}\${NAME}`.
is `%USERPROFILE%\<NAME>`. Environment variables will be expanded at
installation time.
'''), # noqa

('default_prefix_domain_user', False, str, r'''
Set default installation prefix for domain user. If not provided, the
installation prefix for domain user will be `${LOCALAPPDATA}\${NAME}`.
installation prefix for domain user will be `%LOCALAPPDATA%\<NAME>`.
By default, it is different from the `default_prefix` value to avoid installing
the distribution in the roaming profile. Windows only.
the distribution in the roaming profile. Environment variables will be expanded
at installation time. Windows only.
'''), # noqa

('default_prefix_all_users', False, str, r'''
Set default installation prefix for All Users installation. If not provided,
the installation prefix for all users installation will be
`${ALLUSERSPROFILE}\${NAME}`. Windows only.
`%ALLUSERSPROFILE%\<NAME>`. Environment variables will be expanded at installation
time. Windows only.
'''), # noqa

('default_location_pkg', False, str, '''
Expand Down
13 changes: 8 additions & 5 deletions docs/source/construct-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,20 +500,22 @@ _required:_ no<br/>
_type:_ string<br/>

Set default install prefix. On Linux, if not provided, the default prefix
is `${HOME}/${NAME}` (or, if `HOME` is not set, `/opt/${NAME}`). On Windows,
is `${HOME}/<NAME>` (or, if `HOME` is not set, `/opt/<NAME>`). On Windows,
this is used only for "Just Me" installation; for "All Users" installation,
use the `default_prefix_all_users` key. If not provided, the default prefix
is `${USERPROFILE}\${NAME}`.
is `%USERPROFILE%\<NAME>`. Environment variables will be expanded at
installation time.

### `default_prefix_domain_user`

_required:_ no<br/>
_type:_ string<br/>

Set default installation prefix for domain user. If not provided, the
installation prefix for domain user will be `${LOCALAPPDATA}\${NAME}`.
installation prefix for domain user will be `%LOCALAPPDATA%\<NAME>`.
By default, it is different from the `default_prefix` value to avoid installing
the distribution in the roaming profile. Windows only.
the distribution in the roaming profile. Environment variables will be expanded
at installation time. Windows only.

### `default_prefix_all_users`

Expand All @@ -522,7 +524,8 @@ _type:_ string<br/>

Set default installation prefix for All Users installation. If not provided,
the installation prefix for all users installation will be
`${ALLUSERSPROFILE}\${NAME}`. Windows only.
`%ALLUSERSPROFILE%\<NAME>`. Environment variables will be expanded at installation
time. Windows only.

### `default_location_pkg`

Expand Down
19 changes: 19 additions & 0 deletions news/750-default-prefix-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Enhancements

* <news item>

### Bug fixes

* <news item>

### Deprecations

* <news item>

### Docs

* Clarify environment variables role in `default_prefix` and friends on Windows. (#748 via #750)

### Other

* <news item>