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

feat(docs): #1296 add note about homeless-shelter #1297

Merged
merged 1 commit into from
Feb 19, 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
16 changes: 8 additions & 8 deletions docs/src/api/extensions/fundamentals.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,14 +527,14 @@ Types:
to `projectStateDir` otherwise.
Defaults to `false`, if `projectStateDir` is specified or derived.

Note:

- It is implicitly `true`, if `projectStateDir == globalStateDir`.
- `projectStateDir == globalStateDir` is the default if
`projectIdentifier` is not configured.
- Hence, generally enable project local state by
- either setting `projectIdentifier`
- or `projectStateDir` different from `globalStateDir`.
???+ note

- It is implicitly `true`, if `projectStateDir == globalStateDir`.
- `projectStateDir == globalStateDir` is the default if
`projectIdentifier` is not configured.
- Hence, generally enable project local state by
- either setting `projectIdentifier`
- or `projectStateDir` different from `globalStateDir`.

Example:

Expand Down
12 changes: 12 additions & 0 deletions docs/src/api/extensions/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ Types:
For more information see [here](https://github.com/nix-community/poetry2nix/blob/master/docs/edgecases.md).
Defaults to `(self: super: {})`.

???+ note

By default we override every python package deleting the
`homeless-shelter` directory and changing the `HOME` variable,
we make this to assure purity of builds without sandboxing.

Example:

=== "main.nix"
Expand All @@ -43,6 +49,12 @@ Example:
overrides = self: super: {
pygments = super.pygments.overridePythonAttrs (
old: {
preUnpack =
''
export HOME=$(mktemp -d)
rm -rf /homeless-shelter
''
+ (old.preUnpack or "");
buildInputs = [super.setuptools];
}
);
Expand Down
Loading