TheCloud/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-13 17:36:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: add more details to the newly added -compress section

Browse Source
This commit is contained in:
Delyan Angelov 2024-09-07 09:05:57 +03:00
parent 0158b54b7b
commit 3e7f8edb34
No known key found for this signature in database
GPG Key ID: 66886C0F12D595ED
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/docs.md
View File

@ -6923,19 +6923,25 @@ with identical hardware.
#### `-compress` #### `-compress`
This flag executes `upx` to compress the resultant executable, This flag executes `upx` to compress the resultant executable, reducing its size by around 50%-70%.
reducing its size by around 50%-70%. The executable will be uncompressed at runtime, so it will take a bit more time to start.
It will also take extra RAM initially, as the compressed version of the app will be loaded into
memory, and then expanded to another chunk of memory.
Debugging such an application can be a bit harder, if you do not account for it.
Some antivirus programs also use heuristics, that trigger more often for compressed applications.
**When to Use** **When to Use**
- For really tiny environments, where the size of the executable on the file system, - For really tiny environments, where the size of the executable on the file system,
or when deploying is important. The executable will be uncompressed at runtime, or when deploying is important (docker containers, rescue disks etc).
so it will take a bit more time to start.
**When to Avoid** **When to Avoid**
- When you need to debug the application, or when your app's startup time - When you need to debug the application
is extremely important (where 1-2ms can be meaningful for you). - When the app's startup time is extremely important (where 1-2ms can be meaningful for you)
- When you can not afford to allocate more memory during application startup
- When you are deploying an app to users with antivirus software that could misidentify your
app as malicious, just because it decompresses its code at runtime.
#### PGO (Profile-Guided Optimization) #### PGO (Profile-Guided Optimization)