Skip to content

Commit b61382f

Browse files
Update taskfiles/deps/README.md
Co-authored-by: Lin Zhihao <[email protected]>
1 parent ad9e783 commit b61382f

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

taskfiles/deps/README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
Follow the guidelines below when writing or updating dependency installation taskfiles.
44

5-
- Use one of the following tasks for installation, in descending order of preference:
6-
- `deps:utils:install-remote-cmake-lib`
7-
- `yscope-dev-utils:cmake:install-remote-tar`
8-
9-
- For special tasks that don't apply to the rule above:
10-
- Include `deps:utils:init` in the `deps:` section of the task.
11-
- Briefly explain why if the library is installable via CMake.
12-
- Ensure each library installation includes checksum validation using best effort.
13-
- Use of `yscope-dev-utils` tasks is encouraged, as most of them include proper checksum checks.
14-
- Use `<lib>-extracted` as the directory name for tarball extractions.
15-
16-
- Avoid parsing version numbers in download URLs unless the version is used elsewhere, as URL
5+
* Use one of the following tasks for installation, in descending order of preference:
6+
* `deps:utils:install-remote-cmake-lib`
7+
* `yscope-dev-utils:cmake:install-remote-tar`
8+
9+
* For special tasks that don't apply to the rule above:
10+
* Include `deps:utils:init` in the `deps` section of the task.
11+
* Briefly explain why if the library is installable via CMake.
12+
* Ensure each library installation includes checksum validation using the best effort.
13+
* Use of `yscope-dev-utils` tasks is encouraged, as most of them include proper checksum checks.
14+
* Use `<lib>-extracted` as the directory name for tarball extractions.
15+
16+
* Avoid parsing version numbers in download URLs unless the version is used elsewhere, as URL
1717
formats can change over time, making it more maintainable to store and use the full URL directly
1818
as plain text.
1919

@@ -22,19 +22,19 @@ Follow the guidelines below when writing or updating dependency installation tas
2222
Apply the following guidelines to the `CMAKE_GEN_ARGS` section of tasks that call
2323
`deps:utils:install-remote-cmake-lib`:
2424

25-
- Set `CMP0074` to `NEW` whenever:
26-
- The component's minimum required CMake version is less than 3.27 (where `CMP0074` defaults to
25+
* Set `CMP0074` to `NEW` whenever:
26+
* The component's minimum required CMake version is less than 3.27 (where `CMP0074` defaults to
2727
`OLD`)
28-
- The component depends on another via `<lib_name>_ROOT`.
28+
* The component depends on another via `<lib_name>_ROOT`.
2929

30-
- Build both shared and static libraries when possible.
30+
* Build both shared and static libraries when possible.
3131

32-
- Skip unit tests, examples, docs or unused binaries to speed up the install process.
32+
* Skip unit tests, examples, docs or unused binaries to speed up the installation process.
3333

34-
- Prefer disabling lib-specific testing flags (e.g., `CATCH_BUILD_TESTING=OFF`) rather than setting
34+
* Prefer disabling lib-specific testing flags (e.g., `CATCH_BUILD_TESTING=OFF`) rather than setting
3535
the generic `BUILD_TESTING` to `OFF`.
3636

37-
- **Lastly**, while satisfying the above requirements, remove redundant flags that merely restate
37+
* **Lastly**, while satisfying the above requirements, remove redundant flags that merely restate
3838
default values found in `CMakeLists.txt` and others source CMake files, with two exceptions:
39-
- Set `CMAKE_BUILD_TYPE` to `Release` unless another build type is explicitly required.
40-
- Set `CMAKE_INSTALL_MESSAGE` to `LAZY` to reduce log verbosity during installation.
39+
* Set `CMAKE_BUILD_TYPE` to `Release` unless another build type is explicitly required.
40+
* Set `CMAKE_INSTALL_MESSAGE` to `LAZY` to reduce log verbosity during installation.

0 commit comments

Comments
 (0)