diff options
| author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-04-19 10:29:48 +0200 |
|---|---|---|
| committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-04-19 14:44:44 +0200 |
| commit | d35cc739eb5bff4c2374b705d86421270239e36d (patch) | |
| tree | faa91a76fe855965b3e94176ba6ccca0a2bf08da /etc | |
| parent | e92f8c8ce6cda87968eab0617355eda72a1bbbda (diff) | |
| download | rules-cc-d35cc739eb5bff4c2374b705d86421270239e36d.tar.gz | |
README: update and clarify the source of proto tools
Diffstat (limited to 'etc')
| -rw-r--r-- | etc/README.template.md | 21 | ||||
| -rwxr-xr-x | etc/generate-doc.sh | 4 |
2 files changed, 18 insertions, 7 deletions
diff --git a/etc/README.template.md b/etc/README.template.md index 0ad4d9f..98fed9a 100644 --- a/etc/README.template.md +++ b/etc/README.template.md @@ -4,15 +4,20 @@ A collection of rules for building C/C++ libraries and binaries. ## How to use this Repository -Either generate your `repos.json` from a template (`repos.template.json`) by -importing the `rules-cc` repository with the tool `just-import-git` +There are two ways to import this repository. You can generate your +`repos.json` from a template (`repos.template.json`) by importing +the `rules-cc` repository with the tool `just-import-git` ~~~sh $ just-import-git -C repos.template.json --as rules-cc -b master https://github.com/just-buildsystem/rules-cc > repos.json ~~~ -or manually add the `rules-cc` repository to your `repos.json` (also binding -`protobuf` and `grpc` appropriately if proto libraries are to be used). +Importing this way will also pull in `protoc` and `grpc_cpp_plugin` +as a dependency for generating bindings for proto dependencies, if +this feature is used. + +Alternatively, the `rules-cc` repository can be added manually to +your `repos.json`. ~~~json ... @@ -20,7 +25,7 @@ or manually add the `rules-cc` repository to your `repos.json` (also binding { "repository": { "type": "git" , "branch": "master" - , "commit": "c3b895900468f34d6808c56b736ddd88933b81ec" + , "commit": "2ea50063460a3e11dfcbb71651540c0d61fddc1a" , "repository": "https://github.com/just-buildsystem/rules-cc" , "subdir": "rules" } @@ -28,6 +33,12 @@ or manually add the `rules-cc` repository to your `repos.json` (also binding ... ~~~ +Importing this way, `protoc` and `grpc_cpp_plugin` will be taken +from the host system. To change the binary names or to bring your +own proto toolchain, add a corresponding `target_root` layer (and +provide the needed binding, if your target files refer to other +reposistories containing the toolchain). + ## Consume and being consumed by CMake Libraries For interoperability with CMake projects, see diff --git a/etc/generate-doc.sh b/etc/generate-doc.sh index 790a2e0..01b90ce 100755 --- a/etc/generate-doc.sh +++ b/etc/generate-doc.sh @@ -59,6 +59,8 @@ rm -f "$OUTFILE" doc2md rules CC/prebuilt library doc2md rules CC install-with-deps doc2md rules CC/test test + doc2md rules CC defaults + doc2md rules CC/proto defaults doc2md rules shell/test script doc2md rules CC/foreign/cmake library doc2md rules CC/foreign/cmake data @@ -69,5 +71,3 @@ rm -f "$OUTFILE" doc2md rules patch file doc2md rules CC/auto config ) >> "$OUTFILE" - - |