Skip to content

Commit 87f274b

Browse files
userdocsuserdocs
committed
docs
1 parent 3616444 commit 87f274b

File tree

4 files changed

+191
-5
lines changed

4 files changed

+191
-5
lines changed

‎docs/src/components/buildinfo-build-help.astro‎

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
const response = await fetch(
3+
"https://github.com/userdocs/qbt-workflow-files/releases/latest/download/dependency-version.json",
4+
);
5+
6+
const data = await response.json();
7+
8+
const rows = [
9+
{
10+
variable: "qbt_zlib_type",
11+
defaultVal: "zlib",
12+
optionsTokens: ["zlib", "zlib-ng"],
13+
example: 'qbt_zlib_type="zlib"',
14+
},
15+
{
16+
variable: "qbt_skip_icu",
17+
defaultVal: "yes",
18+
optionsTokens: ["yes", "no"],
19+
example: 'qbt_skip_icu="yes"',
20+
},
21+
{
22+
variable: "qbt_boost_tag",
23+
defaultVal: `boost-${data.boost || "1.88.0"}`,
24+
optionsTokens: ["Any valid git tag"],
25+
example: 'qbt_boost_tag="boost-1.86.0"',
26+
},
27+
{
28+
variable: "qbt_libtorrent_version",
29+
defaultVal: "2.0",
30+
optionsTokens: ["1.2", "2.0"],
31+
example: 'qbt_libtorrent_version="2.0"',
32+
},
33+
{
34+
variable: "qbt_libtorrent_tag",
35+
defaultVal: `v${data.libtorrent_2_0 || "2.0.11"}`,
36+
optionsTokens: ["Any valid git tag"],
37+
example: 'qbt_libtorrent_tag="v2.0.10"',
38+
},
39+
{
40+
variable: "qbt_libtorrent_master_jamfile",
41+
defaultVal: "no",
42+
optionsTokens: ["yes", "no"],
43+
example: 'qbt_libtorrent_master_jamfile="no"',
44+
},
45+
{
46+
variable: "qbt_qt_version",
47+
defaultVal: "6",
48+
optionsTokens: ["5.12", "5.15", "6.3", "6.3.1"],
49+
example: 'qbt_qt_version="6"',
50+
},
51+
{
52+
variable: "qbt_qt_tag",
53+
defaultVal: `v${data.qt6 || "v6.9.1"}`,
54+
optionsTokens: ["Any valid git tag"],
55+
example: 'qbt_qt_tag="v6.8.0"',
56+
},
57+
{
58+
variable: "qbt_qbittorrent_tag",
59+
defaultVal: `release-${data.qbittorrent || "5.1.2"}`,
60+
optionsTokens: ["Any valid git tag"],
61+
example: 'qbt_qbittorrent_tag="release-5.1.2"',
62+
},
63+
{
64+
variable: "qbt_build_dir",
65+
defaultVal: "qbt-build",
66+
optionsTokens: ["qbt-build"],
67+
example: 'qbt_build_dir="~/custom"',
68+
},
69+
{
70+
variable: "qbt_build_tool",
71+
defaultVal: "cmake",
72+
optionsTokens: ["cmake", "qmake"],
73+
example: 'qbt_build_tool="cmake"',
74+
},
75+
{
76+
variable: "qbt_cross_name",
77+
defaultVal: "default (default to OS gcc)",
78+
optionsTokens: ["See Cross arch options below"],
79+
example: 'qbt_cross_name="aarch64"',
80+
},
81+
{
82+
variable: "qbt_mcm_url",
83+
defaultVal: "userdocs/qbt-musl-cross-make",
84+
optionsTokens: [],
85+
example: 'qbt_mcm_url="userdocs/qbt-musl-cross-make"',
86+
},
87+
{
88+
variable: "qbt_patches_url",
89+
defaultVal: "userdocs/qbittorrent-nox-static",
90+
optionsTokens: [],
91+
example: 'qbt_patches_url="userdocs/qbittorrent-nox-static"',
92+
},
93+
{
94+
variable: "qbt_workflow_files",
95+
defaultVal: "no",
96+
optionsTokens: ["yes", "no"],
97+
example: 'qbt_workflow_files="no"',
98+
},
99+
{
100+
variable: "qbt_cache_dir",
101+
defaultVal: "empty = unset",
102+
optionsTokens: [],
103+
example: 'qbt_cache_dir="cache"',
104+
},
105+
{
106+
variable: "qbt_optimise_strip",
107+
defaultVal: "yes",
108+
optionsTokens: ["yes", "no"],
109+
example: 'qbt_optimise_strip="yes"',
110+
},
111+
{
112+
variable: "qbt_build_debug",
113+
defaultVal: "no",
114+
optionsTokens: [],
115+
example: 'qbt_build_debug="no"',
116+
},
117+
{
118+
variable: "qbt_standard",
119+
defaultVal: "20",
120+
optionsTokens: ["14", "17", "20", "23"],
121+
example: 'qbt_standard="20"',
122+
},
123+
{
124+
variable: "qbt_static_ish",
125+
defaultVal: "no",
126+
optionsTokens: [],
127+
example: 'qbt_static_ish="no"',
128+
},
129+
{
130+
variable: "qbt_optimise",
131+
defaultVal: "no",
132+
optionsTokens: ["yes", "no"],
133+
example: 'qbt_optimise="yes"',
134+
},
135+
{
136+
variable: "qbt_with_qemu",
137+
defaultVal: "yes",
138+
optionsTokens: ["yes", "no"],
139+
example: 'qbt_with_qemu="yes"',
140+
},
141+
{
142+
variable: "qbt_host_deps_repo",
143+
defaultVal: "userdocs/qbt-host-deps",
144+
optionsTokens: [],
145+
example: "qbt_host_deps_repo=userdocs/qbt-host-deps",
146+
},
147+
];
148+
---
149+
150+
<table>
151+
<thead>
152+
<tr>
153+
<th>Build variable</th>
154+
<th>Default if unset</th>
155+
<th>Options</th>
156+
<th>example usage</th>
157+
</tr>
158+
</thead>
159+
<tbody>
160+
{
161+
rows.map((r) => (
162+
<tr>
163+
<td>
164+
<code>{r.variable}</code>
165+
</td>
166+
<td>
167+
<code>{r.defaultVal}</code>
168+
</td>
169+
<td>
170+
{Array.isArray(r.optionsTokens) && r.optionsTokens.length
171+
? r.optionsTokens.map((opt, i) => (
172+
<Fragment>
173+
<code>{opt}</code>
174+
{i < r.optionsTokens.length - 1 ? " " : ""}
175+
</Fragment>
176+
))
177+
: ""}
178+
</td>
179+
<td>
180+
<code>{r.example}</code>
181+
</td>
182+
</tr>
183+
))
184+
}
185+
</tbody>
186+
</table>

‎docs/src/components/buildinfo.astro‎ renamed to ‎docs/src/components/buildinfo-introduction.astro‎

File renamed without changes.

‎docs/src/components/global.jsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ import Charts from "/src/components/charts.astro";
33
import Details from "/src/components/details.astro";
44
import GithubActions from "/src/components/github-actions.astro";
55
import Modal from "/src/components/modal.astro";
6-
import BuildInfo from "/src/components/buildinfo.astro";
6+
import BuildInfo_i from "/src/components/buildinfo-introduction.astro";
7+
import BuildInfo_b from "/src/components/buildinfo-build-help.astro";
78
import PatchInfo from "/src/components/patchinfo.astro";
89
import ScriptVersions from "/src/components/scriptversions.astro";
910

1011
import { Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon, FileTree } from "@astrojs/starlight/components";
1112

12-
13-
export { Advanced, BuildInfo, Charts, Details, GithubActions, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon, PatchInfo, FileTree, ScriptVersions };
13+
export { Advanced, BuildInfo_i, BuildInfo_b, Charts, Details, GithubActions, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon, PatchInfo, FileTree, ScriptVersions };

‎docs/src/content/docs/introduction.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Introduction
33
description: Introduction
44
---
55

6-
import { Advanced, BuildInfo, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon, ScriptVersions } from "/src/components/global.jsx"
6+
import { Advanced, BuildInfo_i, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon, ScriptVersions } from "/src/components/global.jsx"
77

88
## What is it?
99

@@ -81,7 +81,7 @@ The script is highly configurable and is capable of native and cross building. T
8181

8282
⭐ Here is an example successful default build profile:
8383

84-
<BuildInfo/>
84+
<BuildInfo_i/>
8585

8686
<Tabs>
8787
<TabItem label="Debian and Ubuntu Linux">

0 commit comments

Comments
 (0)