aboutsummaryrefslogtreecommitdiff
path: root/docs/maintainers
diff options
context:
space:
mode:
authorRobert Schumacher <roschuma@microsoft.com>2017-06-06 11:40:47 -0700
committerRobert Schumacher <roschuma@microsoft.com>2017-06-07 14:32:54 -0700
commit76b754e52ddcb2d2a6958e4a913d0371c00279d8 (patch)
tree29042e70dea2fd42fa3e41e378567f8321e11ab1 /docs/maintainers
parent4c33195759bfc2b3bde8628a6617f46040721330 (diff)
downloadvcpkg-76b754e52ddcb2d2a6958e4a913d0371c00279d8.tar.gz
vcpkg-76b754e52ddcb2d2a6958e4a913d0371c00279d8.zip
[vcpkg-docs] Initial commit of triplets documentation
Diffstat (limited to 'docs/maintainers')
-rw-r--r--docs/maintainers/control-files.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/maintainers/control-files.md b/docs/maintainers/control-files.md
index 1cb444df3..e446fe6fa 100644
--- a/docs/maintainers/control-files.md
+++ b/docs/maintainers/control-files.md
@@ -1,16 +1,16 @@
-## `CONTROL` files
-Each port has some static metadata in the form of a `CONTROL` file. This file uses the same rough syntax as and a subset of the fields from [the Debian `control` format][debian].
+# CONTROL files
+Each port has some static metadata in the form of a `CONTROL` file. This file uses the same syntax and a subset of the fields from [the Debian `control` format][debian].
-Fields are case-sensitive.
+Field names are case-sensitive.
[debian]: https://www.debian.org/doc/debian-policy/ch-controlfields.html
-### Recognized fields
+## Recognized fields
-#### Source
+### Source
The name of the port.
-#### Version
+### Version
The port version.
This field should be an alphanumeric string which may also contain `.`, `_`, or `-`. No attempt at ordering versions is made; all versions are treated as bitstrings and are only evaluated for equality.
@@ -22,15 +22,15 @@ Example:
Version: 1.0.5-2
```
-#### Description
+### Description
A description of the library
The first sentence of the description should concisely describe the purpose and contents of the library. Then, a larger description including the library's "proper name" should follow.
-#### Maintainer
+### Maintainer
Reserved for future use.
-#### Build-Depends
+### Build-Depends
The list of dependencies required to build and use this library.
Example: