Skip to content

Commit c62364b

Browse files
userdocsuserdocs
committed
Update build-help.mdx
1 parent 47c1457 commit c62364b

File tree

1 file changed

+43
-27
lines changed

1 file changed

+43
-27
lines changed

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

Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +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"
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";
720

821
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.
922

@@ -13,39 +26,42 @@ bash ~/qbittorrent-nox-static.sh -h
1326

1427
## ENV settings
1528

16-
The script has some `env` settings that can trigger certain behaviour.
29+
The script has some `env` settings that can trigger certain behaviour without the need to pass flags to the script.
1730

18-
:::caution
31+
:::tip
1932
`export` the variables listed below when you use them in your local env.
2033
:::
2134

2235
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.
2336

24-
```bash
25-
| Build variable | Default if unset | Options | example usage |
26-
| ------------------------------- | ----------------------------------- | ---------------------------------- | --------------------------------------------------- |
27-
| `qbt_libtorrent_version` | `2.0` | `1.2` `2.0` | `qbt_libtorrent_version="2.0"` |
28-
| `qbt_qt_version` | `6` | `5.12` `5.15` `6.3` `6.3.1` | `qbt_qt_version="6"` |
29-
| `qbt_build_tool` | `cmake` | `cmake` `qmake` | `qbt_build_tool="cmake"` |
30-
| `qbt_cross_name` | empty = `unset` (default to OS gcc) | `x86_64` `aarch64` `armv7` `armhf` | `qbt_cross_name="default"` |
31-
| `qbt_patches_url` | `username/repo` | `username/repo` | `qbt_patches_url="userdocs/qbittorrent-nox-static"` |
32-
| `qbt_skip_icu` | `yes` | `yes` `no` | `qbt_skip_icu="yes"` |
33-
| `qbt_boost_tag` | latest github stable release or tag | Any valid git tag | `qbt_boost_tag="boost-1.86.0"` |
34-
| `qbt_libtorrent_tag` | latest github stable release or tag | Any valid git tag | `qbt_libtorrent_tag="v2.0.10"` |
35-
| `qbt_qt_tag` | latest github stable release or tag | Any valid git tag | `qbt_qt_tag="v6.8.0"` |
36-
| `qbt_qbittorrent_tag` | latest github stable release or tag | Any valid git tag | `qbt_qbittorrent_tag="release-5.0.1"` |
37-
| `qbt_libtorrent_master_jamfile` | `no` | `yes` `no` | `qbt_libtorrent_master_jamfile="no"` |
38-
| `qbt_workflow_files` | `no` | `yes` `no` | `qbt_workflow_files="no"` |
39-
| `qbt_workflow_artifacts` | `no` | `yes` `no` | `qbt_workflow_artifacts="no"` |
40-
| `qbt_cache_dir` | empty = `unset` | Path: relative or full | `qbt_cache_dir=""` |
41-
| `qbt_optimise_strip` | `yes` | `yes` `no` | `qbt_optimise_strip="yes"` |
42-
| `qbt_build_debug` | `no` | `yes` `no` | `qbt_build_debug="no"` |
43-
| `qbt_standard` | `20` | `14` `17` `20` `23` | `qbt_standard="20"` |
44-
| `qbt_static_ish` | `no` | `yes` `no` | `qbt_static_ish="no"` |
45-
```
37+
| Build variable | Default if unset | Options | example usage |
38+
| ------------------------------- | ----------------------------------- | ---------------------------- | --------------------------------------------------- |
39+
| `qbt_libtorrent_version` | `2.0` | `1.2` `2.0` | `qbt_libtorrent_version="2.0"` |
40+
| `qbt_qt_version` | `6` | `5.12` `5.15` `6.3` `6.3.1` | `qbt_qt_version="6"` |
41+
| `qbt_build_tool` | `cmake` | `cmake` `qmake` | `qbt_build_tool="cmake"` |
42+
| `qbt_cross_name` | empty = `unset` (default to OS gcc) | See Cross arch otpions below | `qbt_cross_name="aarch64"` |
43+
| `qbt_patches_url` | `username/repo` | `username/repo` | `qbt_patches_url="userdocs/qbittorrent-nox-static"` |
44+
| `qbt_skip_icu` | `yes` | `yes` `no` | `qbt_skip_icu="yes"` |
45+
| `qbt_boost_tag` | latest github stable release or tag | Any valid git tag | `qbt_boost_tag="boost-1.86.0"` |
46+
| `qbt_libtorrent_tag` | latest github stable release or tag | Any valid git tag | `qbt_libtorrent_tag="v2.0.10"` |
47+
| `qbt_qt_tag` | latest github stable release or tag | Any valid git tag | `qbt_qt_tag="v6.8.0"` |
48+
| `qbt_qbittorrent_tag` | latest github stable release or tag | Any valid git tag | `qbt_qbittorrent_tag="release-5.0.1"` |
49+
| `qbt_libtorrent_master_jamfile` | `no` | `yes` `no` | `qbt_libtorrent_master_jamfile="no"` |
50+
| `qbt_workflow_files` | `no` | `yes` `no` | `qbt_workflow_files="no"` |
51+
| `qbt_workflow_artifacts` | `no` | `yes` `no` | `qbt_workflow_artifacts="no"` |
52+
| `qbt_cache_dir` | empty = `unset` | Path: relative or full | `qbt_cache_dir=""` |
53+
| `qbt_optimise_strip` | `yes` | `yes` `no` | `qbt_optimise_strip="yes"` |
54+
| `qbt_build_debug` | `no` | `yes` `no` | `qbt_build_debug="no"` |
55+
| `qbt_standard` | `20` | `14` `17` `20` `23` | `qbt_standard="20"` |
56+
| `qbt_static_ish` | `no` | `yes` `no` | `qbt_static_ish="no"` |
57+
58+
<Details summary="Cross arch otpions">
59+
`armel` `armhf` `armv7` `aarch64` `x86_64` `x86` `s390x` `powerpc` `ppc64el`
60+
`mips` `mipsel` `mips64` `mips64el` `riscv64`
61+
</Details>
4662

4763
:::tip
48-
If you see more variables in the script but they are not listed here they are Github Action specific configured by workflows.
64+
If you see more variables in the script but they are not listed here they are Github Action specific configured by workflows and you should ignroe them
4965
:::
5066

5167
:::note
@@ -61,6 +77,7 @@ The `--boot-strap-release` and `--boot-strap-multi-arch` options are specific to
6177
:::
6278

6379
:::tip[Script Help Options]
80+
6481
<Details summary="Script Help Options">
6582
```bash
6683
Here are a list of available options
@@ -257,7 +274,6 @@ The `-b` must be used in all commands provided to the script or default `qbt-bui
257274
The `-b` flag accepts both full `/opt` and relative `opt` paths.
258275
:::
259276

260-
261277
```bash
262278
bash ~/qbittorrent-nox-static.sh all -b "/opt"
263279
```

0 commit comments

Comments
 (0)