Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve registries documentation #429

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Improve registries documentation #429

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3388685
concepts
vicroms Nov 17, 2024
06a5b40
update registries concepts and reference docs
vicroms Nov 17, 2024
a5ead90
Fix broken links
vicroms Nov 18, 2024
23fe81a
Fix broken links 2
vicroms Nov 18, 2024
42c4716
Fix unclosed <a> tag
vicroms Nov 21, 2024
efd1918
Apply suggestions from code review
vicroms Dec 1, 2024
e4f3bc3
Apply suggestions from code review
vicroms Dec 9, 2024
e95db83
Review comments and lint errors
vicroms Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion vcpkg/about/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ We recommend cloning directly from [GitHub](https://github.com/microsoft/vcpkg)

Yes. Follow [our packaging example](../get_started/get-started-packaging.md) to create your own port and see the [overlay ports](../concepts/overlay-ports.md) and [registries](../concepts/registries.md) documentation to learn how to manage your private ports.

You can take this further by publishing your private libraries into a registry. See the article on [Creating registries](../maintainers/registries.md). A registry is a collection of ports, similar to the one provided with vcpkg that contains open source libraries.
You can take this further by publishing your private libraries into a registry. See the article on [Custom registries](../concepts/registries.md). A registry is a collection of ports, similar to the one provided with vcpkg that contains open source libraries.

## Can I use a prebuilt private library with this tool?

Expand Down
2 changes: 1 addition & 1 deletion vcpkg/commands/add-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Specifies the name of the port to be updated. If not provided, the user should u

### `--all`

Processes all the ports in the [built-in](../maintainers/registries.md#builtin-registries) `ports` directory.
Process all the ports in the [built-in](../concepts/registries.md#built-in-registry) `ports` directory.

### `--overwrite-version`

Expand Down
4 changes: 2 additions & 2 deletions vcpkg/concepts/manifest-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ how to [install packages in manifest mode](#install-manifest-mode).

Manifest mode is also required to use advanced features like
[versioning](../users/versioning.md) and
[custom registries](../users/registries.md).
[custom registries](../concepts/registries.md).

## Manifest files in ports

Expand Down Expand Up @@ -79,7 +79,7 @@ feature is not available in classic mode.
## Configuration file

vcpkg can be configured through a `vcpkg-configuration.json` file to add more
[package registries](../users/registries.md) or
[package registries](../concepts/registries.md) or
[overlay ports and triplets](../concepts/overlay-ports.md) locations.

### Configuration file example
Expand Down
2 changes: 1 addition & 1 deletion vcpkg/concepts/overlay-ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ms.topic: concept-article

Usually, vcpkg ports are obtained from [registries](../concepts/registries.md). It is very likely that most of the ports you install come from the official vcpkg registry at <https://github.com/Microsoft/vcpkg>. vcpkg lets you install ports available to you via the file system, we call these ports, overlay ports.

An overlay port can act as a drop-in replacement for an existing port or as a new port that is otherwise not available in a [registry](../maintainers/registries.md). While [resolving package names](../concepts/package-name-resolution.md), overlay ports take priority.
An overlay port can act as a drop-in replacement for an existing port or as a new port that is otherwise not available in a [registry](../concepts/registries.md). While [resolving package names](../concepts/package-name-resolution.md), overlay ports take priority.

Overlay ports are evaluated in the following order:

Expand Down
Loading