Commit Graph

28 Commits

Author SHA1 Message Date
Kai Pastor
b99eebb47f
[doc] Replace "Build Mode" with "Project Mode" (#28196)
* [doc] Replace "Build Mode" with "Project Mode"

CMake clearly separates commands into "Scripting Commands" and "Project Commands", thus implying an official terminology for both modes.

* Update
2022-12-09 15:26:12 -08: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
Thomas1664
c69f2b9098
[vcpkg] Add vcpkg_install_copyright() portfile function (#25239)
* [vcpkg tool] Add vcpkg_install_copyright

* Make sure FILE_LIST is provided

* relative to ${SOURCE_PATH}

* Add documentation

* Add to table of contents

* Relative paths was a bad idea.

* Tell users to use the correct way

Co-authored-by: Billy O'Neal <bion@microsoft.com>

* Fix docs

* Add parameter COMMENT

* Rename to vcpkg_concat_copyright

* Fix escape

* Revert "Fix escape"

This reverts commit 53f1636705.

* Revert "Rename to vcpkg_concat_copyright"

This reverts commit 6ce9152a61.

* Fix escape

* Add support for single copyright file

* Update docs

* Make comment less confusing

* [ci skip] Billy CR

* [ci skip] Format

* Remove explicit checks for STREQUAL ""

* Add error msg if file doesn't exist

Co-authored-by: Billy O'Neal <bion@microsoft.com>
2022-07-13 09:41:52 -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
d4709e69b8
[docs] Update docs for vcpkg_extract_source_archive (#25178)
* [docs] Update docs for vcpkg_extract_source_archive

* [docs] Fix links

* [docs] CR review

* [docs] More CR

* CR comments
2022-06-27 15:16:22 -07:00
Alexander Neumann
339f9225b6
[docs] Update maintainer guide to include CMAKE_REQUIRE_FIND_PACKAGE. (#23321)
Co-authored-by: Alexander Neumann <you@example.com>
2022-03-01 16:22:27 -08: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
Billy O'Neal
6f1d72a4bd
Add notice about how to export unofficial CMake targets. (#23041)
* Add notice about how to export unofficial CMake targets.

* Add Nicole's comments.

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>

* MOAR

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>
2022-02-10 17:12:48 -08:00
Martin Hořeňovský
7a9bfb28d3
[docs] Fix (some) broken links in documentation (#20303)
* Fix broken links to nondeprecated portfile helpers

* Also link through to maintainers cmake ports
2021-09-23 12:32:02 -07:00
Billy O'Neal
53e3b41ae1
[docs] Document deprecated functions from #20142 in the maintainer guide. (#20217)
* Document deprecated functions from #20142 in the maintainer guide.

See discussion at https://github.com/microsoft/vcpkg/pull/20142#issuecomment-921146572

* Reorder list to match natural `portfile.cmake` order, as suggested by @dg0yt
2021-09-20 09:07:26 -07:00
Billy O'Neal
8759c75050
[Docs] Document the unique port attribution rule. (#20087)
* Document the unique port attribution rule.

* Remove reference to #19922

* @strega-nil suggestions :D

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>

Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>
2021-09-13 15:57:41 -07:00
Dawid Wróbel
3fa88493ab
[docs] Fix a typo in CMAKE_DISABLE_FIND_PACKAGE command (#19829)
diff --git a/docs/maintainers/maintainer-guide.md b/docs/maintainers/maintainer-guide.md
index b0dd0c4b7..48ea75d08 100644
--- a/docs/maintainers/maintainer-guide.md
+++ b/docs/maintainers/maintainer-guide.md
@@ -154,7 +154,7 @@ vcpkg_configure_cmake(
   SOURCE_PATH ${SOURCE_PATH}
   PREFER_NINJA
   OPTIONS
-    -CMAKE_DISABLE_FIND_PACKAGE_ZLIB=${CMAKE_DISABLE_FIND_PACKAGE_ZLIB}
+    -DCMAKE_DISABLE_FIND_PACKAGE_ZLIB=${CMAKE_DISABLE_FIND_PACKAGE_ZLIB}
 )
 ```
2021-09-03 17:12:24 -07:00
Billy O'Neal
bed50c7de2
[maintainer-guide.md] Add short names note. (#19956) 2021-09-03 17:05:59 -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
Robert Schumacher
607f143a85
[maintainer-guide] Clarify best practices for default features (#16852) 2021-03-29 09:40:35 -07:00
autoantwort
41593050b6
[docs] link to up to date versioning specification (#16795)
* [docs] link to up to date versioning specification

* Update docs/maintainers/maintainer-guide.md

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>

Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-23 14:28:24 -07:00
nicole mazzuca
c47216ac79
[vcpkg_*_cmake] remove deprecation message (#16480)
* [vcpkg_*_cmake] remove deprecation message

to be replaced by a note in the maintainer-guide
this allows existing ports to build without warnings, so as to avoid warning people unnecessarily,
while still making sure people update when they update ports.

* Update docs/maintainers/maintainer-guide.md
2021-03-02 17:03:34 -08:00
nicole mazzuca
68a74950d0
[vcpkg] Rename port_versions to versions (#15784) 2021-01-21 09:53:22 -08:00
Victor Romero
f649f9a67e
[vcpkg] Add CI check for version files and update maintainer's guideline (#15655)
* Add CI check using dummy version files

* Fix ci test

* Update maintainer's guideline

* Point CI check to actual version files

* Remove --git-verify-trees

* Fix typo

* Fix more typoes

* Even more typos

* Even more typos
2021-01-14 21:29:15 -08:00
Billy O'Neal
5d41154c42
[docs] Document acceptable uses for features. (#15171) 2020-12-17 00:19:02 -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
Jack·Boos·Yu
d367c4c0b8
[vcpkg] Improve format check failure message (#12460)
* [docs] Add format document

* improve the error message

* Check the error message

* Finish test

* restore file list
2020-07-29 21:12:06 -07:00
myd7349
0ab1a9e1c6
[vcpkg] Add new function vcpkg_copy_tools (#8749)
* [vcpkg] Add new function vcpkg_copy_tools

* [cpuinfo][czmq][nanomsg][uriparser] Use vcpkg_copy_tools

* [czmq] Clean even tools are not copied

[libsvm][zyre] Use vcpkg_copy_tools

* [vcpkg-copy-tools] Clean debug/bin

This should fix czmq build error

* [czmq] czmq does not have BUILD_TOOLS option

* [vcpkg] Split clean logic into another function

* [cpuinfo][czmq][nanomsg][uriparser] Fix calling of vcpkg_copy_tools

* [zyre] Fix regression error

* [vcpkg] Update try_remove_empty_directory

* [libsvm] Fix vcpkg_copy_tools call
2020-05-01 15:28:55 -07:00
Wolfgang Stöggl
92af850c1c maintainer-guide.md - Fix link (#8720)
"source_" was missing in the name of the helper function. Fix typo:
vcpkg_extract_archive_ex -> vcpkg_extract_source_archive_ex
2019-10-24 15:51:16 -07:00
Wolfgang Stöggl
d993260886 Fix a typo in maintainer-guide.md (#8383) 2019-09-29 10:50:13 -07:00
Victor Romero
8e7ce6d91a
Add guideline for VCPKG_<LANG>_FLAGS (#7751) 2019-08-19 12:28:30 -07:00
Phil Christensen
0079c186f0
[docs] add notes about manual-link (#7390) 2019-07-23 14:49:45 -07:00
Robert Schumacher
9cfcc71146
[docs] Add maintainer guidelines (#6871)
* [maintainer-guide] Initial commit of maintainer guidelines

* [maintainer-guide] Rearrange sections

* [maintainer-guide] Add note about GitHub Draft PRs

* [maintainer-guide] Improvements

* [maintainer-guide] Address comments about versioning conventions

* [maintainer-guide] Add section about how portfiles interact with CMakeLists.txt

* [maintainer-guidelines] Add link from docs index
2019-06-21 21:33:29 -07:00