diff options
| author | ras0219 <533828+ras0219@users.noreply.github.com> | 2021-03-11 16:37:49 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-11 16:37:49 -0800 |
| commit | 75522bb1f2e7d863078bcd06322348f053a9e33f (patch) | |
| tree | a2b291353763d8de9220645fe649b10122230dcc /docs/specifications | |
| parent | 3c7a12bdf3dd6c29c18647919249c083a6fd3346 (diff) | |
| download | vcpkg-75522bb1f2e7d863078bcd06322348f053a9e33f.tar.gz vcpkg-75522bb1f2e7d863078bcd06322348f053a9e33f.zip | |
[docs] Improve inter-document linking; add 'latest' links (#16502)
* [docs] Improve inter-document linking; add 'latest' links
* [docs] Apply suggestions from code review
Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
Diffstat (limited to 'docs/specifications')
| -rw-r--r-- | docs/specifications/binarycaching.md | 2 | ||||
| -rw-r--r-- | docs/specifications/export-command.md | 2 | ||||
| -rw-r--r-- | docs/specifications/feature-packages.md | 4 | ||||
| -rw-r--r-- | docs/specifications/manifests.md | 4 | ||||
| -rw-r--r-- | docs/specifications/ports-overlay.md | 1 | ||||
| -rw-r--r-- | docs/specifications/prefab.md | 2 | ||||
| -rw-r--r-- | docs/specifications/registries-2.md | 2 | ||||
| -rw-r--r-- | docs/specifications/registries.md | 2 | ||||
| -rw-r--r-- | docs/specifications/scripts-extraction.md | 2 | ||||
| -rw-r--r-- | docs/specifications/versioning.md | 4 |
10 files changed, 24 insertions, 1 deletions
diff --git a/docs/specifications/binarycaching.md b/docs/specifications/binarycaching.md index 3bbd766e1..d9c55d5d1 100644 --- a/docs/specifications/binarycaching.md +++ b/docs/specifications/binarycaching.md @@ -2,6 +2,8 @@ **Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.**
+**Up-to-date documentation is available at [Binarycaching](../users/binarycaching.md).**
+
## Motivation
The primary motivation of binary caching is to accelerate two broad scenarios in an easily accessible way
diff --git a/docs/specifications/export-command.md b/docs/specifications/export-command.md index 4111bfed4..5464e9408 100644 --- a/docs/specifications/export-command.md +++ b/docs/specifications/export-command.md @@ -1,5 +1,7 @@ # Binary Export (Apr 28, 2017) +**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.** + ## 1. Motivation ### A. Build once and share diff --git a/docs/specifications/feature-packages.md b/docs/specifications/feature-packages.md index 81afba080..5737c650a 100644 --- a/docs/specifications/feature-packages.md +++ b/docs/specifications/feature-packages.md @@ -1,6 +1,8 @@ # Proposal: Features / Feature packages (Feb 23 2017)
-**Note: this is the proposal as it was initially accepted and does not necessarily reflect the current behavior.**
+**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.**
+
+**Up-to-date documentation is available at [Selecting Library Features](../users/selecting-library-features.md).**
## 1. Motivation
diff --git a/docs/specifications/manifests.md b/docs/specifications/manifests.md index bc4e1d7cc..f095e77f2 100644 --- a/docs/specifications/manifests.md +++ b/docs/specifications/manifests.md @@ -1,5 +1,9 @@ # Manifests -- `vcpkg.json` +**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.** + +**Up-to-date documentation is available at [Manifests](../users/manifests.md).** + For many other language package managers, there exists a way of writing one's dependencies in a declarative manifest format; we want something similar for vcpkg. What follows is the specification of that feature; this should mean that vcpkg becomes far more user and enterprise-friendly, and is additionally an important diff --git a/docs/specifications/ports-overlay.md b/docs/specifications/ports-overlay.md index d486cfe19..632954fc3 100644 --- a/docs/specifications/ports-overlay.md +++ b/docs/specifications/ports-overlay.md @@ -1,5 +1,6 @@ # Ports Overlay (Jun 19, 2019)
+**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.**
## 1. Motivation
diff --git a/docs/specifications/prefab.md b/docs/specifications/prefab.md index 4574e01ee..f94758b49 100644 --- a/docs/specifications/prefab.md +++ b/docs/specifications/prefab.md @@ -1,5 +1,7 @@ # Vcpkg: export Android prefab Archives (AAR files) +**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.** + Vcpkg can export android archives ([AAR files](https://developer.android.com/studio/projects/android-library)). Once an archive is created, it can imported in Android Studio as a native dependent. The archive is automatically consumed using [android studio's prefab tool](https://github.com/google/prefab). For more information on Prefab, refer to: diff --git a/docs/specifications/registries-2.md b/docs/specifications/registries-2.md index 41a32886b..46429db70 100644 --- a/docs/specifications/registries-2.md +++ b/docs/specifications/registries-2.md @@ -1,5 +1,7 @@ # Registries: Take 2 (including Git Registries) +**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.** + Originally, the design of registries was decided upon and written up in the [Registries RFC](registries.md). However, as we've gotten further into the design process of git registries and versioning, and discussed the interaction of versioning with registries, diff --git a/docs/specifications/registries.md b/docs/specifications/registries.md index 48b392a5c..426593829 100644 --- a/docs/specifications/registries.md +++ b/docs/specifications/registries.md @@ -1,5 +1,7 @@ # Package Federation: Custom Registries +**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.** + As it is now, vcpkg has over 1400 ports in the default registry (the `/ports` directory). For the majority of users, this repository of packages is enough. However, many enterprises need to more closely control their dependencies for one reason or another, and this document diff --git a/docs/specifications/scripts-extraction.md b/docs/specifications/scripts-extraction.md index a617a7741..396e2d4e0 100644 --- a/docs/specifications/scripts-extraction.md +++ b/docs/specifications/scripts-extraction.md @@ -1,5 +1,7 @@ # Scripts Tree Extraction
+**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.**
+
## Background
We extracted vcpkg-tool as part of a future wherein Registries are the primary mechanism for interacting with the ports tree, which would allow the vcpkg tool and associated artifacts to be deployed and figure the rest out on their own. Unfortunately, we have concurrently edited things in the so called "scripts" tree which lives in support of ports but really probably belongs in the vcpkg-tool repo.
diff --git a/docs/specifications/versioning.md b/docs/specifications/versioning.md index 960e87f18..e8122c359 100644 --- a/docs/specifications/versioning.md +++ b/docs/specifications/versioning.md @@ -1,5 +1,9 @@ # Versioning Specification
+**Note: this is the feature as it was initially specified and does not necessarily reflect the current behavior.**
+
+**Up-to-date documentation is available at [Versioning](../users/versioning.md).**
+
## Glossary
Some of the terms used in this document have similar meaning when discussed by the community, and because of that, they can cause confusion and ambiguity. To solve this issue, we will assign specific meaning to these terms and try to keep a consistent usage through the document.
|