Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
userdocs committed Oct 29, 2024
1 parent c62364b commit 5ad176a
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
7 changes: 5 additions & 2 deletions docs/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"typescript.tsdk": "node_modules/typescript/lib"
}
"typescript.tsdk": "node_modules/typescript/lib",
"cSpell.enableFiletypes": [
"mdx"
]
}
10 changes: 5 additions & 5 deletions docs/src/content/docs/build-help.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ You can export these before you run the script to set them. The can be used for
| `qbt_libtorrent_version` | `2.0` | `1.2` `2.0` | `qbt_libtorrent_version="2.0"` |
| `qbt_qt_version` | `6` | `5.12` `5.15` `6.3` `6.3.1` | `qbt_qt_version="6"` |
| `qbt_build_tool` | `cmake` | `cmake` `qmake` | `qbt_build_tool="cmake"` |
| `qbt_cross_name` | empty = `unset` (default to OS gcc) | See Cross arch otpions below | `qbt_cross_name="aarch64"` |
| `qbt_cross_name` | empty = `unset` (default to OS gcc) | See Cross arch options below | `qbt_cross_name="aarch64"` |
| `qbt_patches_url` | `username/repo` | `username/repo` | `qbt_patches_url="userdocs/qbittorrent-nox-static"` |
| `qbt_skip_icu` | `yes` | `yes` `no` | `qbt_skip_icu="yes"` |
| `qbt_boost_tag` | latest github stable release or tag | Any valid git tag | `qbt_boost_tag="boost-1.86.0"` |
Expand All @@ -55,17 +55,17 @@ You can export these before you run the script to set them. The can be used for
| `qbt_standard` | `20` | `14` `17` `20` `23` | `qbt_standard="20"` |
| `qbt_static_ish` | `no` | `yes` `no` | `qbt_static_ish="no"` |

<Details summary="Cross arch otpions">
<Details summary="Cross arch options">
`armel` `armhf` `armv7` `aarch64` `x86_64` `x86` `s390x` `powerpc` `ppc64el`
`mips` `mipsel` `mips64` `mips64el` `riscv64`
</Details>

:::tip
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
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 ignore them
:::

:::note
If you set `qbt_build_tool=qmake` and `qbt_qt_version=5` you can build qBittorrent v4 or earleir using Qt5.
If you set `qbt_build_tool=qmake` and `qbt_qt_version=5` you can build qBittorrent v4 or earlier using Qt5.
:::

## Switches and flags summarised
Expand Down Expand Up @@ -126,7 +126,7 @@ The `--boot-strap-release` and `--boot-strap-multi-arch` options are specific to
qttools ------------ required Build qttools locally
qbittorrent -------- required Build qbittorrent locally

env help - supported exportable evironment variables
env help - supported exportable environment variables

export qbt_libtorrent_version="" -------- options 1.2 - 2.0
export qbt_qt_version="" ---------------- options 5 - 5.15 - 6 - 6.2 - 6.3 and so on
Expand Down
2 changes: 1 addition & 1 deletion qbittorrent-nox-static.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2088,7 +2088,7 @@ while (("${#}")); do
printf '%b\n' " ${text_dim}${color_magenta_light}qtbase${color_end} ${text_dim}-------------${color_end} ${text_dim}${color_red_light}required${color_end} ${text_dim}Build qtbase locally${color_end}"
printf '%b\n' " ${text_dim}${color_magenta_light}qttools${color_end} ${text_dim}------------${color_end} ${text_dim}${color_red_light}required${color_end} ${text_dim}Build qttools locally${color_end}"
printf '%b\n' " ${text_dim}${color_magenta_light}qbittorrent${color_end} ${text_dim}--------${color_end} ${text_dim}${color_red_light}required${color_end} ${text_dim}Build qbittorrent locally${color_end}"
printf '\n%b\n' " ${text_bold}${text_underlined}env help - supported exportable evironment variables${color_end}"
printf '\n%b\n' " ${text_bold}${text_underlined}env help - supported exportable environment variables${color_end}"
printf '\n%b\n' " ${text_dim}${color_magenta_light}export qbt_libtorrent_version=\"\"${color_end} ${text_dim}--------${color_end} ${text_dim}${color_red_light}options${color_end} ${text_dim}1.2 - 2.0${color_end}"
printf '%b\n' " ${text_dim}${color_magenta_light}export qbt_qt_version=\"\"${color_end} ${text_dim}----------------${color_end} ${text_dim}${color_red_light}options${color_end} ${text_dim}5 - 5.15 - 6 - 6.2 - 6.3 and so on${color_end}"
printf '%b\n' " ${text_dim}${color_magenta_light}export qbt_build_tool=\"\"${color_end} ${text_dim}----------------${color_end} ${text_dim}${color_red_light}options${color_end} ${text_dim}qmake - cmake${color_end}"
Expand Down

0 comments on commit 5ad176a

Please sign in to comment.