Skip to content

Commit ee7892d

Browse files
userdocsuserdocs
committed
Update build-help.mdx
1 parent ad84711 commit ee7892d

File tree

1 file changed

+58
-26
lines changed

1 file changed

+58
-26
lines changed

‎docs/src/content/docs/build-help.mdx‎

Lines changed: 58 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@ title: Build Help
33
description: Build Help
44
---
55

6-
import { Advanced, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from "/src/components/global.jsx"
7-
6+
import {
7+
Advanced,
8+
Charts,
9+
Details,
10+
Modal,
11+
Steps,
12+
Tabs,
13+
TabItem,
14+
Card,
15+
CardGrid,
16+
LinkCard,
17+
Aside,
18+
Icon,
19+
} from "/src/components/global.jsx";
820

921
Once the script has successfully configured the platform you can execute the help switch to see how it works and what options you have available to you.
1022

@@ -20,26 +32,37 @@ The script has some `env` settings that can trigger certain behaviour.
2032
`export` the variables listed below when you use them in your local env.
2133
:::
2234

23-
You can export these before you run the script to set them. There is not specific benefit to using these over the flags and switches.
24-
25-
| Build variable | Default if unset | Options | example usage |
26-
| ------------------------------- | ----------------------------------- | ---------------------------------- | -------------------------------------------------------- |
27-
| `qbt_libtorrent_version` | `2.0` | `1.2` `2.0` | `export qbt_libtorrent_version=2.0` |
28-
| `qbt_qt_version` | `6.3` | `5.12` `5.15` `6.3` `6.3.1` | `export qbt_qt_version=6.3` |
29-
| `qbt_build_tool` | `qmake` | `cmake` | `export qbt_build_tool=cmake` |
30-
| `qbt_cross_name` | empty = `unset` (default to OS gcc) | `x86_64` `aarch64` `armv7` `armhf` | `export qbt_cross_name=aarch64` |
31-
| `qbt_patches_url` | `userdocs/qbittorrent-nox-static` | `username/repo` | `export qbt_patches_url=userdocs/qbittorrent-nox-static` |
32-
| `qbt_workflow_files` | empty = `unset` (defaults to no) | `yes` `no` | `export qbt_workflow_files=yes` |
33-
| `qbt_libtorrent_master_jamfile` | empty = `unset` (defaults to no) | `yes` `no` | `export qbt_libtorrent_master_jamfile=yes` |
34-
| `qbt_optimise_strip` | empty = `unset` (defaults to no) | `yes` `no` | `export qbt_optimise_strip=yes` |
35-
| `qbt_build_debug` | empty = `unset` (defaults to no) | `yes` `no` | `export qbt_build_debug=yes` |
35+
You can export these before you run the script to set them. The can be used for docker builds or local builds and work in the `.qbt_env` file.
36+
37+
````bash
38+
39+
| Build variable | Default if unset | Options | example usage |
40+
| ------------------------------- | ----------------------------------- | ---------------------------------- | --------------------------------------------------- |
41+
| `qbt_libtorrent_version` | `2.0` | `1.2` `2.0` | `qbt_libtorrent_version="2.0"` |
42+
| `qbt_qt_version` | `6` | `5.12` `5.15` `6.3` `6.3.1` | `qbt_qt_version="6"` |
43+
| `qbt_build_tool` | `cmake` | `cmake` `qmake` | `qbt_build_tool="cmake"` |
44+
| `qbt_cross_name` | empty = `unset` (default to OS gcc) | `x86_64` `aarch64` `armv7` `armhf` | `qbt_cross_name="default"` |
45+
| `qbt_patches_url` | `username/repo` | `username/repo` | `qbt_patches_url="userdocs/qbittorrent-nox-static"` |
46+
| `qbt_skip_icu` | `yes` | `yes` `no` | `qbt_skip_icu="yes"` |
47+
| `qbt_boost_tag` | latest github stable release or tag | Any valid git tag | `qbt_boost_tag="boost-1.86.0"` |
48+
| `qbt_libtorrent_tag` | latest github stable release or tag | Any valid git tag | `qbt_libtorrent_tag="v2.0.10"` |
49+
| `qbt_qt_tag` | latest github stable release or tag | Any valid git tag | `qbt_qt_tag="v6.8.0"` |
50+
| `qbt_qbittorrent_tag` | latest github stable release or tag | Any valid git tag | `qbt_qbittorrent_tag="release-5.0.1"` |
51+
| `qbt_libtorrent_master_jamfile` | `no` | `yes` `no` | `qbt_libtorrent_master_jamfile="no"` |
52+
| `qbt_workflow_files` | `no` | `yes` `no` | `qbt_workflow_files="no"` |
53+
| `qbt_workflow_artifacts` | `no` | `yes` `no` | `qbt_workflow_artifacts="no"` |
54+
| `qbt_cache_dir` | empty = `unset` | Path: relative or full | `qbt_cache_dir=""` |
55+
| `qbt_optimise_strip` | `yes` | `yes` `no` | `qbt_optimise_strip="yes"` |
56+
| `qbt_build_debug` | `no` | `yes` `no` | `qbt_build_debug="no"` |
57+
| `qbt_standard` | `20` | `14` `17` `20` `23` | `qbt_standard="20"` |
58+
| `qbt_static_ish` | `no` | `yes` `no` | `qbt_static_ish="no"` |
3659

3760
:::tip
3861
If you see more variables in the script but they are not listed here they are Github Action specific configured by workflows.
3962
:::
4063

4164
:::note
42-
If you set `qbt_build_tool=cmake` and `qt_version=6.2` with the switch `-qm` you can build against QT6.
65+
If you set `qbt_build_tool=qmake` and `qbt_qt_version=5` you can build qBittorrent v4 or earleir using Qt5.
4366
:::
4467

4568
## Switches and flags summarised
@@ -51,6 +74,7 @@ The `--boot-strap-release` and `--boot-strap-multi-arch` options are specific to
5174
:::
5275

5376
:::tip[Script Help Options]
77+
5478
<Details summary="Script Help Options">
5579
```bash
5680
Here are a list of available options
@@ -124,13 +148,13 @@ The `--boot-strap-release` and `--boot-strap-multi-arch` options are specific to
124148
qbt_libtorrent_version="2.0"
125149
qbt_qt_version="6"
126150
qbt_build_tool="cmake"
127-
qbt_cross_name="x86_64"
151+
qbt_cross_name="default"
128152
qbt_patches_url="userdocs/qbittorrent-nox-static"
129153
qbt_skip_icu="yes"
130-
qbt_boost_tag="boost-1.84.0"
154+
qbt_boost_tag="boost-1.86.0"
131155
qbt_libtorrent_tag="v2.0.10"
132-
qbt_qt_tag="v6.6.2"
133-
qbt_qbittorrent_tag="release-4.6.3"
156+
qbt_qt_tag="v6.8.0"
157+
qbt_qbittorrent_tag="release-5.0.1"
134158
qbt_libtorrent_master_jamfile="no"
135159
qbt_workflow_files="no"
136160
qbt_workflow_artifacts="no"
@@ -139,7 +163,9 @@ The `--boot-strap-release` and `--boot-strap-multi-arch` options are specific to
139163
qbt_build_debug="no"
140164
qbt_standard="17"
141165
qbt_static_ish="no"
142-
```
166+
167+
````
168+
143169
</Details>
144170
:::
145171
@@ -157,7 +183,9 @@ Add your patches there, for example.
157183
~/qbt-build/patches/libtorrent/1.2.18/patch
158184

159185
~/qbt-build/patches/qbittorrent/4.5.0/patch
160-
```
186+
187+
````
188+
161189
</TabItem>
162190
<TabItem value="" label=" -qm -lm -h-bs">
163191
```bash
@@ -170,7 +198,9 @@ Add your patches there, for example.
170198
~/qbt-build/patches/libtorrent/RC_1_2/patch
171199
172200
~/qbt-build/patches/qbittorrent/master/patch
173-
```
201+
202+
````
203+
174204
</TabItem>
175205
<TabItem value="" label=" -qt release-4.2.5 -lt v2.0.3 -h-bs">
176206
```bash
@@ -183,7 +213,9 @@ Add your patches there, for example.
183213
~/qbt-build/patches/libtorrent/2.0.3/patch
184214

185215
~/qbt-build/patches/qbittorrent/4.2.5/patch
186-
```
216+
217+
`````
218+
187219
</TabItem>
188220
</Tabs>
189221
@@ -247,8 +279,8 @@ The `-b` must be used in all commands provided to the script or default `qbt-bui
247279
The `-b` flag accepts both full `/opt` and relative `opt` paths.
248280
:::
249281
250-
```bash
282+
````bash
251283
252284
```bash
253285
bash ~/qbittorrent-nox-static.sh all -b "/opt"
254-
```
286+
`````

0 commit comments

Comments
 (0)