diff options
| author | ras0219 <533828+ras0219@users.noreply.github.com> | 2020-07-07 13:53:19 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-07 13:53:19 -0700 |
| commit | f9bdf139535f25dd0847fecff22a1c8c606da613 (patch) | |
| tree | 9ffe023676b93d7f4bd4400dced790d96b3ac906 /docs/examples/installing-and-using-packages.md | |
| parent | 12333a6b96848445fd04b19a8f7e00cdaf2ad0b6 (diff) | |
| download | vcpkg-f9bdf139535f25dd0847fecff22a1c8c606da613.tar.gz vcpkg-f9bdf139535f25dd0847fecff22a1c8c606da613.zip | |
[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>
Diffstat (limited to 'docs/examples/installing-and-using-packages.md')
| -rw-r--r-- | docs/examples/installing-and-using-packages.md | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/docs/examples/installing-and-using-packages.md b/docs/examples/installing-and-using-packages.md index 82371149b..f98de78ab 100644 --- a/docs/examples/installing-and-using-packages.md +++ b/docs/examples/installing-and-using-packages.md @@ -14,7 +14,7 @@ First, we need to know what name [SQLite](https://sqlite.org) goes by in the por ```no-highlight PS D:\src\vcpkg> .\vcpkg search sqlite libodb-sqlite 2.4.0 Sqlite support for the ODB ORM library -sqlite3 3.15.0 SQLite is a software library that implements a se... +sqlite3 3.32.1 SQLite is a software library that implements a se... If your library is not listed, please open an issue at: https://github.com/Microsoft/vcpkg/issues @@ -24,38 +24,38 @@ Looking at the list, we can see that the port is named "sqlite3". You can also r Installing is then as simple as using the `install` command. ```no-highlight PS D:\src\vcpkg> .\vcpkg install sqlite3 --- CURRENT_INSTALLED_DIR=D:/src/vcpkg/installed/x86-windows --- DOWNLOADS=D:/src/vcpkg/downloads --- CURRENT_PACKAGES_DIR=D:/src/vcpkg/packages/sqlite3_x86-windows --- CURRENT_BUILDTREES_DIR=D:/src/vcpkg/buildtrees/sqlite3 --- CURRENT_PORT_DIR=D:/src/vcpkg/ports/sqlite3/. --- Downloading https://sqlite.org/2016/sqlite-amalgamation-3150000.zip... --- Downloading https://sqlite.org/2016/sqlite-amalgamation-3150000.zip... OK --- Testing integrity of downloaded file... --- Testing integrity of downloaded file... OK --- Extracting source D:/src/vcpkg/downloads/sqlite-amalgamation-3150000.zip --- Extracting done --- Configuring x86-windows-rel --- Configuring x86-windows-rel done --- Configuring x86-windows-dbg --- Configuring x86-windows-dbg done --- Build x86-windows-rel --- Build x86-windows-rel done --- Build x86-windows-dbg --- Build x86-windows-dbg done --- Package x86-windows-rel --- Package x86-windows-rel done --- Package x86-windows-dbg --- Package x86-windows-dbg done +Computing installation plan... +The following packages will be built and installed: + sqlite3[core]:x86-windows +Starting package 1/1: sqlite3:x86-windows +Building package sqlite3[core]:x86-windows... +-- Downloading https://sqlite.org/2020/sqlite-amalgamation-3320100.zip... +-- Extracting source C:/src/vcpkg/downloads/sqlite-amalgamation-3320100.zip +-- Applying patch fix-arm-uwp.patch +-- Using source at C:/src/vcpkg/buildtrees/sqlite3/src/3320100-15aeda126a.clean +-- Configuring x86-windows +-- Building x86-windows-dbg +-- Building x86-windows-rel -- Performing post-build validation -- Performing post-build validation done -Package sqlite3:x86-windows is installed +Building package sqlite3[core]:x86-windows... done +Installing package sqlite3[core]:x86-windows... +Installing package sqlite3[core]:x86-windows... done +Elapsed time for package sqlite3:x86-windows: 12 s + +Total elapsed time: 12.04 s + +The package sqlite3:x86-windows provides CMake targets: + + find_package(sqlite3 CONFIG REQUIRED) + target_link_libraries(main PRIVATE sqlite3) + ``` -We can check that sqlite3 was successfully installed for x86 windows desktop by running the `list` command. +We can check that sqlite3 was successfully installed for x86 Windows desktop by running the `list` command. ```no-highlight PS D:\src\vcpkg> .\vcpkg list -sqlite3:x86-windows 3.15.0 SQLite is a software library that implements a se... +sqlite3:x86-windows 3.32.1 SQLite is a software library that implements a se... ``` To install for other architectures and platforms such as Universal Windows Platform or x64 Desktop, you can suffix the package name with `:<target>`. @@ -82,7 +82,7 @@ Installing new libraries will make them instantly available. ``` *Note: You will need to restart Visual Studio or perform a Build to update intellisense with the changes.* -You can now simply use File -> New Project in Visual Studio 2015 or Visual Studio 2017 and the library will be automatically available. For SQLite, you can try out their [C/C++ sample](https://sqlite.org/quickstart.html). +You can now simply use File -> New Project in Visual Studio and the library will be automatically available. For SQLite, you can try out their [C/C++ sample](https://sqlite.org/quickstart.html). To remove the integration for your user, you can use `.\vcpkg integrate remove`. @@ -92,7 +92,7 @@ To remove the integration for your user, you can use `.\vcpkg integrate remove`. The best way to use installed libraries with cmake is via the toolchain file `scripts\buildsystems\vcpkg.cmake`. To use this file, you simply need to add it onto your CMake command line as: `-DCMAKE_TOOLCHAIN_FILE=D:\src\vcpkg\scripts\buildsystems\vcpkg.cmake`. -If you are using CMake through Open Folder with Visual Studio 2017 you can define `CMAKE_TOOLCHAIN_FILE` by adding a "variables" section to each of your `CMakeSettings.json` configurations: +If you are using CMake through Open Folder with Visual Studio you can define `CMAKE_TOOLCHAIN_FILE` by adding a "variables" section to each of your `CMakeSettings.json` configurations: ```json { |
