diff options
| author | nicole mazzuca <mazzucan@outlook.com> | 2020-09-14 15:07:02 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-14 15:07:02 -0700 |
| commit | 0fec1340eba828e95c489796eb0c7a4330120686 (patch) | |
| tree | a5e9f8e8592705c790ae0e987fd2b36219a3276d /docs/examples/packaging-zipfiles.md | |
| parent | 76362dd2b2e4d9b03f6722219c8a1189e3a255fa (diff) | |
| download | vcpkg-0fec1340eba828e95c489796eb0c7a4330120686.tar.gz vcpkg-0fec1340eba828e95c489796eb0c7a4330120686.zip | |
[vcpkg manifest] Add documentation! (#13488)
* [vcpkg docs] add docs for manifest files
These are just for the maintainer docs,
not user docs.
* [vcpkg] EBNF-ify platform expression parsing
this modifies nothing about what strings are accepted or rejected,
it just moves stuff around.
also adds tests.
* [vcpkg docs] add manifest mode example
* [wip] docs for augustin
also fix tabs
* [vcpkg manifest] switch to using maps for features
* Apply suggestions from code review
* un-experimentize format-manifest
* flesh out the user manifest mode docs
* CRs
* billy CRs
* final personal pass-thru
Diffstat (limited to 'docs/examples/packaging-zipfiles.md')
| -rw-r--r-- | docs/examples/packaging-zipfiles.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/examples/packaging-zipfiles.md b/docs/examples/packaging-zipfiles.md index 056eb5287..9ece22d93 100644 --- a/docs/examples/packaging-zipfiles.md +++ b/docs/examples/packaging-zipfiles.md @@ -13,21 +13,23 @@ Finally, if the server's name for the archive is not very descriptive (such as d *`zlib1211.zip` is a fine name, so no change needed.* -All this information can then be passed into the `create` command, which will download the sources and bootstrap the packaging process inside `ports\<packagename>`. +All this information can then be passed into the `create` command, which will download the sources and bootstrap the packaging process inside `ports/<packagename>`. ```no-highlight PS D:\src\vcpkg> .\vcpkg create zlib2 http://zlib.net/zlib-1.2.11.tar.gz zlib1211.tar.gz -- Generated portfile: D:/src/vcpkg/ports/zlib2/portfile.cmake ``` -### Create the CONTROL file -In addition to the generated `ports\<package>\portfile.cmake`, we also need a `ports\<package>\CONTROL` file. This file is a simple set of fields describing the package's metadata. +### Create the manifest file +In addition to the generated `ports/<package>/portfile.cmake`, we also need a `ports/<package>/vcpkg.json` file. This file is a simple set of fields describing the package's metadata. -*For zlib2, we'll create the file `ports\zlib2\CONTROL` with the following contents:* -```no-highlight -Source: zlib2 -Version: 1.2.11 -Description: A Massively Spiffy Yet Delicately Unobtrusive Compression Library +*For zlib2, we'll create the file `ports/zlib2/vcpkg.json` with the following contents:* +```json +{ + "name": "zlib2", + "version-string": "1.2.11", + "description": "A Massively Spiffy Yet Delicately Unobtrusive Compression Library" +} ``` ### Tweak the generated portfile @@ -62,7 +64,7 @@ Found 3 error(s). Please correct the portfile: At this point, it is a matter of reading the error messages and log files while steadily improving the quality of the portfile. Zlib required providing a discrete copy of the LICENSE to copy into the package, suppressing the build and installation of executables and headers, and removing the static libraries after they were installed. ### Suggested example portfiles -In the `ports\` directory are many libraries that can be used as examples, including many that are not based on CMake. +In the `ports/` directory are many libraries that can be used as examples, including many that are not based on CMake. - Header only libraries - rapidjson |
