aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornicole mazzuca <mazzucan@outlook.com>2021-01-21 09:53:22 -0800
committerGitHub <noreply@github.com>2021-01-21 09:53:22 -0800
commit68a74950d0400f5a803026d0860f49853984bf11 (patch)
treea2122f59fd991381290b3d8fbd884ccf6f41121c /docs
parentbedeaa639c21a759ad211b048deb7968a6648f10 (diff)
downloadvcpkg-68a74950d0400f5a803026d0860f49853984bf11.tar.gz
vcpkg-68a74950d0400f5a803026d0860f49853984bf11.zip
[vcpkg] Rename `port_versions` to `versions` (#15784)
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/maintainer-guide.md10
-rw-r--r--docs/specifications/versioning.md10
2 files changed, 10 insertions, 10 deletions
diff --git a/docs/maintainers/maintainer-guide.md b/docs/maintainers/maintainer-guide.md
index 6ceb51912..9a65d1790 100644
--- a/docs/maintainers/maintainer-guide.md
+++ b/docs/maintainers/maintainer-guide.md
@@ -204,16 +204,16 @@ For Example:
See our [manifest files document](manifest-files.md#port-version) for a full explanation of our conventions.
-### Update the version files in `port_versions/` of any modified ports
+### Update the version files in `versions/` of any modified ports
Vcpkg uses a set of metadata files to power its versioning feature.
These files are located in the following locations:
-* `${VCPKG_ROOT}/port_versions/baseline.json`, (this file is common to all ports) and
-* `${VCPKG_ROOT}/port_versions/${first-letter-of-portname}-/${portname}.json` (one per port).
+* `${VCPKG_ROOT}/versions/baseline.json`, (this file is common to all ports) and
+* `${VCPKG_ROOT}/versions/${first-letter-of-portname}-/${portname}.json` (one per port).
For example, for `zlib` the relevant files are:
-* `${VCPKG_ROOT}/port_versions/baseline.json`
-* `${VCPKG_ROOT}/port_versions/z-/zlib.json`
+* `${VCPKG_ROOT}/versions/baseline.json`
+* `${VCPKG_ROOT}/versions/z-/zlib.json`
We expect that each time you update a port, you also update its version files.
diff --git a/docs/specifications/versioning.md b/docs/specifications/versioning.md
index 7cbf89aec..960e87f18 100644
--- a/docs/specifications/versioning.md
+++ b/docs/specifications/versioning.md
@@ -171,7 +171,7 @@ Baselines are used to set lower boundaries on package versions. A baseline effec
But what is a baseline?
-In the main registry, the baseline is a file located in `${VCPKG_ROOT}/port_versions/baseline.json`. This file contains a version declaration for each package in vcpkg. The format of this file is the following:
+In the main registry, the baseline is a file located in `${VCPKG_ROOT}/versions/baseline.json`. This file contains a version declaration for each package in vcpkg. The format of this file is the following:
```json
{
@@ -319,9 +319,9 @@ Although the concept of package versions has always been present in vcpkg, the c
With the introduction of versioning constraints, it is now possible that a package depends on a port version that does not match the one available locally. This raises a problem as vcpkg needs to know how to acquire the port files for the requested version.
-To solve this problem, a new set of metadata needs to be introduced. This specification proposes a that a new “port_versions” folder is added as part of a registry. In the main vcpkg registry, this means a new root level port_versions directory.
+To solve this problem, a new set of metadata needs to be introduced. This specification proposes a that a new "versions" folder is added as part of a registry. In the main vcpkg registry, this means a new root level versions directory.
-The port_versions directory, from here on referred as the versions database, will contain JSON files for each one of the ports available in the registry. Each file will list all the versions available for a package and contain a Git tree-ish object that vcpkg can check out to obtain that version’s portfiles.
+The versions directory, from here on referred as the versions database, will contain JSON files for each one of the ports available in the registry. Each file will list all the versions available for a package and contain a Git tree-ish object that vcpkg can check out to obtain that version’s portfiles.
As part of the versioning implementation, a generator for these database files will be implemented. The generator will extract from our repository’s Git history, all the versions of each port that had been available at any moment in time and compile them into these database files.
@@ -349,5 +349,5 @@ Example: generated `zlib.json`
}
```
-For each port, its corresponding versions file should be located in `port_versions/{first letter of port name}-/{port name}.json`. For example, zlib’s version file will be located in `port_versions/z-/zlib.json`.
-Aside from port version files, the current baseline file is located in `port_versions/baseline.json`.
+For each port, its corresponding versions file should be located in `versions/{first letter of port name}-/{port name}.json`. For example, zlib’s version file will be located in `versions/z-/zlib.json`.
+Aside from port version files, the current baseline file is located in `versions/baseline.json`.