From 5ad176a183d5757c357d195ce5d3c22de29e91e3 Mon Sep 17 00:00:00 2001 From: userdocs <16525024+userdocs@users.noreply.github.com> Date: Tue, 29 Oct 2024 19:31:30 +0000 Subject: [PATCH] docs --- docs/.vscode/settings.json | 7 +++++-- docs/src/content/docs/build-help.mdx | 10 +++++----- qbittorrent-nox-static.sh | 2 +- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/.vscode/settings.json b/docs/.vscode/settings.json index 3662b370..ed987632 100644 --- a/docs/.vscode/settings.json +++ b/docs/.vscode/settings.json @@ -1,3 +1,6 @@ { - "typescript.tsdk": "node_modules/typescript/lib" -} \ No newline at end of file + "typescript.tsdk": "node_modules/typescript/lib", + "cSpell.enableFiletypes": [ + "mdx" + ] +} diff --git a/docs/src/content/docs/build-help.mdx b/docs/src/content/docs/build-help.mdx index 3887ba03..45a37d3c 100644 --- a/docs/src/content/docs/build-help.mdx +++ b/docs/src/content/docs/build-help.mdx @@ -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"` | @@ -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"` | -
+
`armel` `armhf` `armv7` `aarch64` `x86_64` `x86` `s390x` `powerpc` `ppc64el` `mips` `mipsel` `mips64` `mips64el` `riscv64`
:::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 @@ -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 diff --git a/qbittorrent-nox-static.sh b/qbittorrent-nox-static.sh index f25ea3cd..f07148cd 100644 --- a/qbittorrent-nox-static.sh +++ b/qbittorrent-nox-static.sh @@ -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}"