Skip to content

Commit

Permalink
[docs] Fix broken links (#17566)
Browse files Browse the repository at this point in the history
* [docs] Fix broken links

* Fix the charactor

* Update the charactor
  • Loading branch information
PhoebeHui authored Apr 29, 2021
1 parent 4f942e1 commit 713e3ae
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This too
- [Installing and Using Packages Example: sqlite](examples/installing-and-using-packages.md)
- [Packaging Zipfiles Example: zlib](examples/packaging-zipfiles.md)
- [Packaging GitHub Repositories Example: libogg](examples/packaging-github-repos.md)
- [Patching Example: Patching libpng to work for x86-uwp](examples/patching.md)
- [Patching Example: Patching libpng to work for x64-uwp](examples/patching.md)
- [Getting Started with Versioning](examples/versioning.getting-started.md)

### User Help
Expand Down
2 changes: 1 addition & 1 deletion docs/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you want to contribute but don't have a particular library in mind then take
of [new port requests](https://github.com/Microsoft/vcpkg/issues?q=is%3Aissue+is%3Aopen+label%3Acategory%3Anew-port).

## Can Vcpkg create pre-built binary packages? What is the binary format used by Vcpkg?
Yes! See [the `export` command](../users/integration.md#export).
Yes! See [the `export` command](../users/integration.md#export-command).

## How do I update libraries?
The `vcpkg update` command lists all packages which are out-of-sync with your current portfiles. To update a package, follow the instructions in the command.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/patching.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Call Stack (most recent call first):
Error: build command failed
```

Next, looking at the above logs (build-...-out.log and build-...-err.log).
Next, looking at the above logs (build-xxx-out.log and build-xxx-err.log).

```no-highlight
// build-x64-uwp-rel-out.log
Expand Down
2 changes: 1 addition & 1 deletion docs/maintainers/control-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Description: C++ header-only JSON library
Description: Mosquitto is an open source message broker that implements the MQ Telemetry Transport protocol versions 3.1 and 3.1.1.
MQTT provides a lightweight method of carrying out messaging using a publish/subscribe model. This makes it suitable for "machine
to machine" messaging such as with low power sensors or mobile devices such as phones, embedded computers or microcontrollers like the Arduino.
````
```

#### Homepage
The URL of the homepage for the library where a user is able to find additional documentation or the original source code.
Expand Down
4 changes: 2 additions & 2 deletions docs/users/config-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ repo versions and executable versions can cause issues.
#### VCPKG_VISUAL_STUDIO_PATH

This environment variable can be set to the full path to a Visual Studio instance on the machine. This Visual Studio instance
will be used if the triplet does not override it via the [`VCPKG_VISUAL_STUDIO_PATH` triplet setting](triplets.md#VCPKG_VISUAL_STUDIO_PATH).
will be used if the triplet does not override it via the [`VCPKG_VISUAL_STUDIO_PATH`](triplets.md#VCPKG_VISUAL_STUDIO_PATH) triplet setting.

Example: `D:\2017`

Expand All @@ -42,7 +42,7 @@ This environment variable can be set to a triplet name which will be used for un

#### VCPKG_DEFAULT_HOST_TRIPLET

This environment variable can be set to a triplet name which will be used for unqualified host port references in command lines and all host port references in dependency lists. See [the Tools documentation](tools.md) for more information.
This environment variable can be set to a triplet name which will be used for unqualified host port references in command lines and all host port references in dependency lists. See [the host-dependencies documentation](host-dependencies.md) for more information.

#### VCPKG_OVERLAY_PORTS

Expand Down
4 changes: 2 additions & 2 deletions docs/users/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Vcpkg offers many ways to integrate into your build so you can do what's right f

Each integration style has heuristics to deduce the correct [triplet][]. This can be overridden using [a common method](#triplet-selection) based on your buildsystem.

<a name="integrate"></a>
<a name="integrate-command"></a>
### Integrate Command

These link your project(s) to a specific copy of Vcpkg on your machine so any updates or new package installations will be instantly available for the next build of your project.
Expand Down Expand Up @@ -96,7 +96,7 @@ See your build system specific documentation for how to use prebuilt binaries.

Generally, to run any produced executables you will also need to either copy the needed DLL files to the same folder as your executable or *prepend* the correct `bin\` directory to your path.

<a name="export"></a>
<a name="export-command"></a>
### Export Command
This command creates a shrinkwrapped archive containing a specific set of libraries (and their dependencies) that can be quickly and reliably shared with build servers or other users in your organization.

Expand Down
6 changes: 3 additions & 3 deletions docs/users/versioning.implementation-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ To compute an installation plan, vcpkg follows roughly these steps:
* If there is a previous version selected:
* If the versioning scheme of the new constraint does not match that of the previously selected version:
* Add a version conflict.
* If the constraints version is not comparable to the previously selected version. For example, comparing version-string: apple to version-string: orange:
* If the constraint's version is not comparable to the previously selected version. For example, comparing "version-string: apple" to "version-string: orange":
* Add a version conflict.
* If the constraints version is higher than the previously selected version:
* Select the highest version.
Expand All @@ -102,7 +102,7 @@ With the introduction of versioning constraints, it is now possible that a packa

To solve this problem, a new set of metadata files was introduced. These files are located in the `versions/` directory at the root level of the vcpkg repository.

The `versions/` directory, 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 versions portfiles.
The `versions/` directory, 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.

Example: `zlib.json`

Expand All @@ -129,6 +129,6 @@ Example: `zlib.json`
}
```

For each port, its corresponding versions file should be located in `versions/{first letter of port name}-/{port name}.json`. For example, zlibs 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`.
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`.


2 changes: 1 addition & 1 deletion docs/users/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ See also the [manifest documentation](manifests.md) for more syntax information.

## Original Specification

See also the [original specification](https://github.com/vicroms/vcpkg/blob/versioning-spec/docs/specifications/versioning.md)
See also the [original specification](https://github.com/microsoft/vcpkg/blob/master/docs/specifications/versioning.md)
6 changes: 3 additions & 3 deletions docs/users/versioning.reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* [Version constraints](#version-constraints)

## Version schemes
Ports in vcpkg should attempt to follow the versioning conventions used by the packages authors. For that reason, when declaring a packages version the appropriate scheme should be used.
Ports in vcpkg should attempt to follow the versioning conventions used by the package's authors. For that reason, when declaring a package's version the appropriate scheme should be used.

Each versioning scheme defines its own rules on what is a valid version string and more importantly the rules for how to sort versions using the same scheme.

Expand Down Expand Up @@ -172,7 +172,7 @@ Accepts a Git commit ID. Vcpkg will try to find a baseline file in the given com
When resolving version constraints for a package, vcpkg will look for a baseline version:
* First by looking at the baseline file in the given commit ID.
* If the given commit ID does not contain a baseline file, vcpkg will fallback to use the local baseline file instead.
* If theres no local baseline file, vcpkg will use the version currently available in the ports directory.
* If there's no local baseline file, vcpkg will use the version currently available in the ports directory.

_NOTE: If a baseline file is found, but it does not contain an entry for the package, the vcpkg invocation will fail._

Expand All @@ -186,7 +186,7 @@ Example:
}
```

Baselines can be used without any other version constraints to obtain behavior close to using classic mode.
Baselines can be used without any other version constraints to obtain behavior close to using "classic" mode.

### `version>=`
Expresses a minimum version requirement, `version>=` declarations put a lower boundary on the versions that can be used to satisfy a dependency.
Expand Down

0 comments on commit 713e3ae

Please sign in to comment.