45 Commits

Author SHA1 Message Date
Billy O'Neal
9b02054e43
Add a new-port checklist to the new PR template. (#27447)
* Add a new-port checklist to the new PR template.

I have observed many people tend to "tune out" our current pull request template, including maintainers, who don't even look at the content and sometimes miss important things people are trying to tell us. To that end, I would like to replace it with something more useful, including things for people submitting the most common kinds of PRs to check.

* Apply fixes suggested by @vicroms and @PhoebeHui
2023-01-19 16:59:05 -08:00
Kang Lin
c4d7348057
[VCPKG DOCS] FIX the checksum of the downloaded file from zip to tag.gz (#28101)
* FIX the checksum of the downloaded file from zip to tag.gz

* Update docs/examples/packaging-github-repos.md

Co-authored-by: Alexander Neumann <30894796+Neumann-A@users.noreply.github.com>

Co-authored-by: Alexander Neumann <30894796+Neumann-A@users.noreply.github.com>
2022-12-01 11:18:38 -08:00
Robert Schumacher
179dbd0627
[docs] Fix TOCs, inline command (#26412) 2022-08-22 09:20:25 -07:00
Robert Schumacher
23cc58477e
[docs] Rewrite docs for vcpkg_cmake_build and vcpkg_cmake_install (#25477)
* [docs] Rewrite docs for vcpkg_cmake_build and vcpkg_cmake_install

* [docs] Fix broken links

* [docs] Add notes about parent helper port
2022-08-16 15:51:42 -07:00
Robert Schumacher
3f71620c2b
[docs] Rewrite doc for vcpkg_cmake_configure. Move up into docs/maintainers/. (#25255)
* [docs] Rewrite doc for vcpkg_cmake_configure. Move up into docs/maintainers/.

* [docs] CR

* PR comment
2022-06-29 07:09:02 -07:00
Robert Schumacher
59aa3a9eec
[docs] Add documentation for x-update-baseline (#25256) 2022-06-23 14:59:09 -07:00
rinechran
ae041b7c6b
[docs] fix 404 url (#25325)
* [docs] fix 404 url

* [docs] Updating related documents

Co-authored-by: rinechran <rinechran@gmail.com>
2022-06-23 13:52:53 -07:00
Robert Schumacher
1e91cd3769
[docs] Remove out-of-date docs, improve header standardization. (#24456)
* Remove out-of-date docs, improve header standardization.

* PR scoping & comments
2022-05-18 14:25:13 -07:00
Robert Schumacher
8639e65b88
[docs] Split integration.md per Build System. (#24737)
* Split integration.md per Build System.

Centralize buildsystem configuration.

* PR comment
2022-05-17 17:12:53 -07:00
Thomas1664
f7db911f44
[vcpkg docs] Remove deprecated functions from docs (#23018)
* Remove deprecated functions from docs

* Fix docs in cmake files

* Fix links
2022-02-17 17:08:33 -08:00
Sandy
864a477457
[docs] Fix linking error in android cmake example (#22866) 2022-01-31 19:41:03 -08:00
Robert Schumacher
1a1f31ce26
[docs] Update docs with full release of manifests, registries, and versioning (#21929)
* [docs] Update docs with full release of manifests, registries, and versioning

* [docs] CR changes
2022-01-06 15:55:41 -08:00
Billy O'Neal
5fd29d9350
Fix title capitalization from https://github.com/vcpkg/vcpkg.github.io/pull/54 (#19345) 2021-08-03 13:56:45 -07:00
Victor Romero
3c82e1931e
[docs] More Getting Started fixes (#18970)
* Use valid commmit ID for baseline

* More doc fixes
2021-07-20 16:24:38 -07:00
Victor Romero
b15a9f3350
Use valid commmit ID for baseline (#18969) 2021-07-15 15:38:20 -07:00
NancyLi1013
3910b29767
[vcpkg_download_distfile] Add condition for padding the SHA (#18459) 2021-06-15 10:14:40 -07:00
ras0219
3738723dd2
Update versioning.getting-started.md (#18000) 2021-05-18 23:15:29 -07:00
Kai Pastor
5a271a9290
[doc] Fix spelling errors (#17560)
* [doc] Fix spelling errors in docs

* [doc] Fix spelling errors in scripts

* Bump version

* x-add-version

* Fix another typo

* Rebuild
2021-05-09 10:48:42 -07:00
Robert Schumacher
2924119c1e
[docs] Consolidate versioning documentation (#17580)
Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-05-03 09:43:34 -07:00
Phoebe
713e3aeb3f
[docs] Fix broken links (#17566)
* [docs] Fix broken links

* Fix the charactor

* Update the charactor
2021-04-29 13:39:50 -07:00
tre
7fea4f15c4
fix example code. (#17502) 2021-04-28 13:14:27 -07:00
ras0219
75522bb1f2
[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>
2021-03-11 16:37:49 -08:00
Victor Romero
d53885f073
[vcpkg] [docs] Add Boost versioning example (#16381)
* Add boost versioning example

* Simplify text

* Fix formatting
2021-03-01 09:45:26 -08:00
dweckmann
e2d3408547
[cppunit] add linux support and bump version to 1.15.1 (#15018) 2020-12-28 19:35:08 -08:00
nicole mazzuca
0fec1340eb
[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
2020-09-14 15:07:02 -07:00
Phoebe
f3221c0405
[sqlite3] Namespaced targets with unofficial:: (#12516)
* [sqlite3] Namespaced targets with unofficial::

* Fix failure ports

* Update the targets name

* Update related docs
2020-08-05 10:36:25 -07:00
ras0219
f9bdf13953
[vcpkg] Implement --editable (#12200)
--editable suppresses binary caching and source re-extraction for packages listed on the command line (similar to --head).

This fundamentally changes the port maintenance loop, so several example documents were updated. To avoid users having substantial changes suddenly destroyed by forgetting to pass --editable, "clean" sources have different extract locations.

The undocumented command `build` implies `--editable`.

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-07-07 13:53:19 -07:00
Leonid Pospelov
5f237aa8a4
Mention --ignore-space-at-eol in patching.md (#11952) 2020-06-18 15:35:30 -07:00
James Liu
92db9a65e6
[docs] fix CMakeLists example for SQLite3 (#11763)
* docs: fix CMakeLists example for SQLite3

* docs: simplify CMake config

* fix: remove extra parenthesis
2020-06-05 10:58:29 -07:00
Pascal Thomet
55be137d5b
[vcpkg] Improve Android doc (triplets, usage with cmake and prefab) (#11264)
* Android: add docs/examples/vcpkg_android_example_cmake/

* Add docs/users/android.md

* Improve Android prefab doc

Following additional informations given by @atkawa7 at
https://github.com/microsoft/vcpkg/pull/11264

* Link to android.md
* Update the prefab usage instructions: "vcpkg install"
    the 4 archs before exporting a prefab
* added --prefab-debug flag
* added gradle integration info
* reviewed the prefab output directory structure
  (from a dump of an actual export)

* docs/users/triplets.md: link to android.md

* docs/index.md: link to android.md

* android.md: specify 2 possibiities for android_ndk_home

* Added examples/vcpkg_android_example_cmake_script/cmake/vcpkg_android.cmake

Usage:

1. Main CMakeLists:
  if (VCPKG_TARGET_ANDROID)
      include("cmake/vcpkg_android.cmake")
  endif()

2. cmake invocation:
  cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a

* trigger pipeline build

* trigger pipelines
2020-05-13 16:42:13 -07:00
Michael Kelley
a5a244f5bd
Correct parameter reference (#10472)
- Change references to --overlay-ports to --overlay-triplets
2020-03-20 16:37:09 -07:00
Griffin Downs
43fa3e60cf
Remove deprecated call to include 2019-12-16 16:15:01 -08:00
Robert Schumacher
4d551ff4b3 [vcpkg-docs] Reword and reorganize overlay-triplets-linux-dynamic.md (#7502) 2019-08-02 15:42:17 -07:00
Victor Romero
30a3e3256f
Example: Building dynamic libraries on Linux using overlay triplets (#7291)
* Example building dynamic libraries on Linux using overlay triplets

* Change triplets list to multi-columns

* Override default triplets example
2019-07-17 11:34:31 -07:00
Victor Romero
7a18088cf2
[vcpkg create, docs] Update create command's template and documentation on patching (#5370) 2019-02-15 14:32:07 -08:00
Roelf-Jilling
370984d139 Merge branch 'master' into documentation 2018-11-20 19:45:21 +01:00
Roelf-Jilling
381e4c94af Move -DCMAKE_... to a new line to prevent the line-break after the dash. 2018-11-19 19:47:31 +01:00
Roelf-Jilling
94ec7c46a5 Add note, to delete the CMake cache, after editing a configuration. 2018-11-19 19:35:00 +01:00
Simon Brand
077b7f1378 Add packaging GitHub repo example 2018-11-16 11:24:19 +00:00
Simon Brand
56c94a8102 Rename example documents
The current names and titles of the examples put too much emphasis on the package which is being demonstrated rather than the concept. This can be jarring for newcomers. This patch renames them to put the emphasis on the concept instead.
2018-11-15 11:23:34 +00:00
tbeu
60820a02eb Update zlib version 2018-09-02 21:01:51 +02:00
Frederik Gladhorn
bd5bad18e4 Fix typo (#3856)
* Fix typo

* [docs] Simplify wording further
2018-07-08 21:07:26 -07:00
Cleroth
22a7da849d Fixed misspelling 2018-05-28 23:28:12 -07:00
Robert Schumacher
53e61d4ab5 [docs][packaging-zlib] Fix example doc. 2018-01-31 12:20:27 -08:00
Robert Schumacher
49cd399586 [vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-28 14:15:13 -07:00