📄 Improve documentation in Terminology section

This commit is contained in:
C-3PO 2018-10-13 21:40:23 +02:00
parent 1171545ac6
commit 40bb7c8178
Signed by: c3po
GPG key ID: 62993C4BB4D86F24

View file

@ -74,8 +74,8 @@ Instead of the SSN patcher, the live game (but not the PTS) can also be installe
SSN uses the following terms; make sure you are familiar with them since we use them as well in documentation and in code. SSN uses the following terms; make sure you are familiar with them since we use them as well in documentation and in code.
- __`product`__: SWTOR is split into multiple products. That way, you can choose to only install part of SWTOR. For example, if you install the products `assets_swtor_main` and `assets_swtor_en_us`, you only have the English-language live client files and no other languages and no PTS. - __`product`__: SWTOR is split into multiple products. That way, you can choose to only install part of SWTOR. For example, if you install the products `assets_swtor_main` and `assets_swtor_en_us`, you only have the English-language live client files and no other languages and no PTS.
- __`release`__: Colloquially, this is known as a “patch” or “Game Update”. For example, release `264` in product `assets_swtor_main` refers to Game Update 5.2.0. However, not every release can be mapped to a “patch”; sometimes there are multiple releases between two actual “patches”, e.g. because of build errors or because they need to add a hotfix via another release before the “patch” can be pushed to the live servers. A release is always an integer starting at `0`. - __`release`__: Colloquially, this is known as a “patch” or “Game Update”. For example, release `264` in product `assets_swtor_main` refers to Game Update 5.2.0. However, not every release can be mapped to a “patch”; sometimes there are multiple releases between two actual “patches”, e.g. because of build errors or because after a release is built, an urgent issue crops up that requires a hotfix before the “patch” can be pushed to the live servers. A release is always an integer starting at `0`.
- __`patch`__: In the SSN sense, a patch refers to the difference between two releases. For example, `263to264` is a patch that can be used to update a product from release `263` to release `264`. The first number is called `from` while the second number is `to`. In order to install a patch, the release given in the `from` number must already be installed on your disk, with one exception: If the `from` number is `-1`, e.g. in patch `-1to0`, the patch does not store the differences but it has full file contents to allow for a fresh install. - __`patch`__: In the SSN sense, a patch refers to the difference between two releases. For example, `263to264` is a patch that can be used to update a product from release `263` to release `264`. The first number is called `from` while the second number is `to`. In order to install a patch, the release given in the `from` number must already be installed on your disk, with one exception: If the `from` number is `-1`, e.g. in patch `-1to0`, the patch does not store the differences but it has the full file contents to allow for a fresh install.
- __`environment`__: An environment consists of multiple products. For example, the live environment (`swtor`) has products like `assets_swtor_main` while the PTS environment (`publictest`) has `assets_swtor_test_main`. - __`environment`__: An environment consists of multiple products. For example, the live environment (`swtor`) has products like `assets_swtor_main` while the PTS environment (`publictest`) has `assets_swtor_test_main`.
- __`manifest`__: Each product has a manifest, a single file that lists all releases and all patches, and specifies which release is the current release (that the launcher must install). - __`manifest`__: Each product has a manifest, a single file that lists all releases and all patches, and specifies which release is the current release (that the launcher must install).