Skip to content

Commit d56f6e1

Browse files
authored
docs: update troubleshooting section (#455)
1 parent 38b5e5a commit d56f6e1

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

docs/index.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The build backends generate recipes in two locations:
6060
#### 1. General Recipe (all outputs)
6161

6262
```
63-
<your_project>/.pixi/build/work/<package-name>--<hash>/work/
63+
<your_project>/.pixi/build/work/<package-name>--<hash>/debug/
6464
```
6565

6666
This directory contains:
@@ -71,7 +71,7 @@ This directory contains:
7171
#### 2. Variant-Specific Recipe (single output)
7272

7373
```
74-
<your_project>/.pixi/build/work/<package-name>--<hash>/work/recipe/<variant_hash>/
74+
<your_project>/.pixi/build/work/<package-name>--<hash>/debug/recipe/<variant_hash>/
7575
```
7676

7777
This directory contains:
@@ -83,24 +83,24 @@ This directory contains:
8383

8484
To debug or rebuild a package using the same configuration, you have two options:
8585

86-
### Option 1: Navigate to the recipe directory
86+
#### Option 1: Navigate to the recipe directory
8787

8888
1. Navigate to the recipe directory:
8989
```bash
90-
cd .pixi/build/work/<package-name>--<hash>/work/recipe/<variant_hash>/
90+
cd .pixi/build/work/<package-name>--<hash>/recipe/<variant_hash>/debug/
9191
```
9292

9393
2. Use `rattler-build` to rebuild the package:
9494
```bash
9595
rattler-build build
9696
```
9797

98-
### Option 2: Point to the recipe directory
98+
#### Option 2: Point to the recipe directory
9999

100100
Use the `--recipe` flag to build without changing directories:
101101

102102
```bash
103-
rattler-build build --recipe .pixi/build/work/<package-name>--<hash>/work/recipe/<variant_hash>/
103+
rattler-build build --recipe .pixi/build/work/<package-name>--<hash>/debug/recipe/<variant_hash>/
104104
```
105105

106106
This allows you to:
@@ -112,6 +112,15 @@ This allows you to:
112112
!!! tip
113113
The `<variant_hash>` ensures that each unique combination of build variants gets its own recipe directory, making it easy to compare different build configurations.
114114

115+
### Debugging JSON-RPC
116+
117+
You can find JSON version of your project model and requests/responses in the same directory alongside `recipe.yaml`.
118+
We store:
119+
120+
- Project model: `project_model.json`
121+
- Requests: `*_params.json`
122+
- Responses: `*_response.json`
123+
115124
## 🔗 Useful Links
116125

117126
- [GitHub](https://github.com/prefix-dev/pixi): Pixi source code, feel free to leave a star!

0 commit comments

Comments
 (0)