Skip to content

Commit 06b2458

Browse files
committed
Update README.md
Update changelog.md docs docs
1 parent e11d7d5 commit 06b2458

File tree

5 files changed

+73
-38
lines changed

5 files changed

+73
-38
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,36 @@ The build has 5 main dependencies tracked that will trigger a rebuild on an upda
119119

120120
When a new build is triggered for updating `qBittorrent` or `Libtorrent` a new release will be generated as the release tags will be updated.
121121

122-
Since I do not append revision info to tags `Qt` - `Boost` - `Openssl` builds will only update the existing release assets.
122+
Since I do not append revision info to tags `Qt` - `Boost` - `Openssl` or patched builds it will only update the existing release assets.
123123

124-
To track these revisions you can use this command. All new releases start at a revision of `0` and increment by `1` per revised build.
124+
Revisions values are incremented in the `dependency-version.json` of the release. All new releases start at a revision of `0` and increment by `1` per revised build.
125+
126+
### Tracking latest release revisions (Libtorrent v2.0)
127+
128+
Simply use this command.
125129

126130
```bash
127131
jq -r '.revision' < <(curl -sL "https://github.com/userdocs/qbittorrent-nox-static/releases/latest/download/dependency-version.json")
128132
```
129133

134+
### Tracking v2.0 and v1.2 releases independently
135+
136+
There are times when the revision counts may differ between `v2.0` and `v1.2` builds as the `dependency-version.json` is unique to the release but has some shared values that won't change. In this case you need to track them as independent values unique to their release.
137+
138+
To do this you start by getting the current release version value first, for example, getting the `v1.2` prerelease revision value.
139+
140+
```bash
141+
release="$(jq -r '. | "release-\(.qbittorrent)_v\(.libtorrent_1_2)"' < <(curl -sL https://github.com/userdocs/qbittorrent-nox-static/releases/latest/download/dependency-version.json))"
142+
```
143+
144+
Then get the revision from that specific release.
145+
146+
```bash
147+
jq -r '.revision' < <(curl -sL "https://github.com/userdocs/qbittorrent-nox-static/releases/download/${release}/dependency-version.json")
148+
```
149+
150+
Now you have tracked the current revision of the latest release of the libtorrent v1.2 binary.
151+
130152
## Dependency json
131153

132154
From `release-4.4.5` each release contains a `dependency-version.json` file that provide some key version information for that is shared across the latest release and the twinned pre release. This helps to overcome some limitations of the API for consistently and directly accessing this information.

changelog.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
### v2.1.3 / v2.0.19 - 29/06/2025
2+
3+
problem: when the `-lt` flag was used with libtorrent `v1.2` like `-lt v1.2.20` boost was not being defaulted `boost-1.86.0` as it does when setting the env equivalent causing a build error when libtorrent was built.
4+
5+
fix: the flag now properly checks and sets boost to `boost-1.86.0` when libtorrent `v1.2` is being built via [e11d7d5](https://github.com/userdocs/qbittorrent-nox-static/commit/e11d7d51b5a0a6a99fcac6ae44c4603286e9a598)
6+
17
### v2.1.2 / v2.0.18 - 18/05/2025
28

39
fix: `double_conversion` all versions - apply patch for increasing cmake bounds in `CMakeLists.txt` via this [patch](https://github.com/google/double-conversion/commit/0604b4c18815aadcf7f4b78dfa6bfcb91a634ed7)
@@ -26,7 +32,7 @@ Hardening is preferred over performance.
2632

2733
`qbt-nox-static.bash``v2.1.0`
2834

29-
`qbt-nox-static.bash` will start with `v2.1.0` and `qbittorrent-nox-static.sh` will be frozen at `v2.0.15`going forward. This is to avoid breaking anything by replacing `qbittorrent-nox-static.sh` with`qbt-nox-static.bash` and removing access to the old file. `v2.1.0` is not really changing the outcome but the behaviour of the script towards that outcome. So the least disruptive way is the opt in route. I also wanted to changed the extension from `sh` to `bash` as it is a bash script.
35+
`qbt-nox-static.bash` will start with `v2.1.0` and `qbittorrent-nox-static.sh` will be frozen at `v2.0.15` going forward. This is to avoid breaking anything by replacing `qbittorrent-nox-static.sh` with`qbt-nox-static.bash` and removing access to the old file. `v2.1.0` is not really changing the outcome but the behaviour of the script towards that outcome. So the least disruptive way is the opt in route. I also wanted to changed the extension from `sh` to `bash` as it is a bash script.
3036

3137
There is feature parity between the two scripts as of this change. All major changes, fixes and tweaks are applied to both scripts with the exception of the reworked dependency and module installation logic which breaks expected behavior of the script.
3238

@@ -68,8 +74,11 @@ see `v2.1.0` changelog
6874
### v2.0.14 - 31/12/2024
6975

7076
fix: libtorrent `v1.2` and boost `1.86.0` check to not ignore `RC_1_2`
77+
7178
fix: the `_apply_patches` function was assuming the remote default branch name of `master` which made it fail the check. It now tests for the remote default branch of a patch repo and uses that.
79+
7280
fix: boost source URL. jfrog source is just a problem. Script now defaults to github boost release and falls back to archives.boost.i, jfrog is purged.
81+
7382
fix: Some typos
7483

7584
### v2.0.13 - 31/12/2024
@@ -109,8 +118,11 @@ fix - <https://github.com/userdocs/qbittorrent-nox-static/commit/b51e1ef356fbdbd
109118
### v2.0.7 - 12-02-2024
110119

111120
Added: a boost download function to combine some logic around fallback urls and minimise external calls.
121+
112122
Added: a check to build combos for qt + cmake to prevent env files trying to build a known bad combo.
123+
113124
fixed: modules check for whole word and not accept partial matches
125+
114126
fixed: associative arrays declared earlier and in a group to allow changing settings via functions
115127

116128
### v2.0.6 - 2024-01-27
@@ -125,20 +137,21 @@ Tests were added for `static-ish` and `optimise` to check for bad combinations,
125137

126138
Codename: Copilot made me do it
127139

128-
Improved readability of the colour variables used throughout the script.
129-
Some minor tweaks to OS detection
130-
Moved some things around or into their own functions and some error handling.
131-
Some changes to how cxx standard is handled and defined so the script will default to 23 when the conditions are met.
132-
minor bug fix - `qbt_libtorrent_version` displays correctly when using an RC github tag.
140+
- Improved readability of the colour variables used throughout the script.
141+
- Some minor tweaks to OS detection
142+
- Moved some things around or into their own functions and some error handling.
143+
- Some changes to how cxx standard is handled and defined so the script will default to 23 when the conditions are met.
144+
- minor bug fix - `qbt_libtorrent_version` displays correctly when using an RC github tag.
133145

134146
Support for Ubuntu Noble added - Mantic removed as it's preferred to support LTS releases
135147

136-
Ubuntu Focal - Jammy - Noble
137-
Debian Bullseye - Bookworm
148+
- Ubuntu Focal - Jammy - Noble
149+
- Debian Bullseye - Bookworm
138150

139151
### v2.0.4 - 16-01-2024
140152

141153
Make sure the workflow override applies when using cached dependencies
154+
142155
Allow patching from a remote raw git patch via URL - an file called `url` in the patch repo for the module version that contains a URL to the raw patch
143156
other minor tweaks and cosmetic changes
144157

@@ -174,18 +187,18 @@ docs to be updated soon.
174187

175188
A quick summary of main changes and features from v1.5.0 through vto 2.0.0
176189

177-
No more bison or gawk building. They are OS dependencies now and need to be installed on the host.
178-
Alpine only - Increased multiarch target support, updated musl cross tools and optimised size.
179-
A caching mechanism for files to store and manage download dependencies to avoid re-downloading them across builds.
180-
Any valid boost tag can be provided including beta tags. It was not a tag based check before.
181-
Any valid qt tag can be provided including beta tags.
182-
patches system reworked to allow patching any module. Source code files can also be used from app_version/source
183-
Improved the way tags are checked and the changes applied to be more consistent throughout the script.
184-
Removed any trace of gnu.org for being a really unreliable source location.
185-
optimised multiarch configurations and multiarch various bug fixes.
186-
Alpine only - Ninja is now prebuilt instead of locally built.
187-
All url data can be viewed using the -sdu switch.
188-
Lots of small tweaks, removing code and simplifying code and rebuilding functions.
190+
- No more bison or gawk building. They are OS dependencies now and need to be installed on the host.
191+
- Alpine only - Increased multiarch target support, updated musl cross tools and optimised size.
192+
- A caching mechanism for files to store and manage download dependencies to avoid re-downloading them across builds.
193+
- Any valid boost tag can be provided including beta tags. It was not a tag based check before.
194+
- Any valid qt tag can be provided including beta tags.
195+
- patches system reworked to allow patching any module. Source code files can also be used from app_version/source
196+
- Improved the way tags are checked and the changes applied to be more consistent throughout the script.
197+
- Removed any trace of gnu.org for being a really unreliable source location.
198+
- optimised multiarch configurations and multiarch various bug fixes.
199+
- Alpine only - Ninja is now prebuilt instead of locally built.
200+
- All url data can be viewed using the -sdu switch.
201+
- Lots of small tweaks, removing code and simplifying code and rebuilding functions.
189202

190203
### v1.1.0 - 18-03-2023
191204

docs/package-lock.json

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
"astro": "astro"
1111
},
1212
"dependencies": {
13-
"@astrojs/starlight": "^0.34.3",
13+
"@astrojs/starlight": "^0.34.4",
1414
"@expressive-code/plugin-collapsible-sections": "^0.41.1",
15-
"astro": "^5.8.1",
15+
"astro": "^5.10.1",
1616
"gray-matter": "^4.0.3",
1717
"sharp": "^0.32.5",
1818
"starlight-image-zoom": "^0.9.0"

docs/src/content/docs/script-installation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ curl -sLo qbittorrent-nox-static.sh git.io/qbstatic && chmod +x qbittorrent-nox-
6161
<TabItem value="Debian Linux" label="Debian">
6262

6363
:::note[tags]
64-
You use `debian:bullseye` `debian:bookworm` `debian:latest` or a supported tag
64+
You use `debian:bookworm` `debian:latest` or a supported tag
6565
:::
6666

6767
To bootstrap the container:
@@ -80,7 +80,7 @@ curl -sLo qbittorrent-nox-static.sh git.io/qbstatic && chmod +x qbittorrent-nox-
8080
<TabItem value="Ubuntu Linux" label="Ubuntu">
8181

8282
:::note[tags]
83-
You use `ubuntu:jammy` `ubuntu:noble` `ubuntu:latest`
83+
You use `ubuntu:noble` `ubuntu:latest`
8484
:::
8585

8686
To bootstrap the container:

0 commit comments

Comments
 (0)