summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2023-02-28 15:35:13 +0100
committerKlaus Aehlig <klaus.aehlig@huawei.com>2023-02-28 15:35:13 +0100
commit0ae82631426f41fb94ebf85f7a997eda80945760 (patch)
tree5754b3f17b26c39cb7ca5da2008ea26ea0c2d702 /README.md
parent178d6a116fb99fe0abe458338135443314fc18ef (diff)
downloadrules-cc-0ae82631426f41fb94ebf85f7a997eda80945760.tar.gz
Update documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index b5d95d0..f93b352 100644
--- a/README.md
+++ b/README.md
@@ -60,7 +60,7 @@ A C++ library
| ----- | ----------- |
| `"name"` | The name of the library (without leading `"lib"` or trailing `".a"`). |
| `"stage"` | The logical location of all header and source files, as well as the resulting library file. Individual directory components are joined with `"/"`. |
-| `"pure C"` | If non-empty, compile as C sources rathter than C++ sources. In particular, CC is used to compile rather than CXX (or their respective defaults). |
+| `"pure C"` | If non-empty, compile as C sources rather than C++ sources. In particular, CC is used to compile rather than CXX (or their respective defaults). |
| `"defines"` | List of defines set for this target and its consumers. Each list entry will be prepended by `"-D"`. |
| `"private-defines"` | List of defines set for source files local to this target. Each list entry will be prepended by `"-D"`. |
| `"cflags"` | List of compile flags set for this target and its consumers. |
@@ -234,15 +234,15 @@ Data produced by Make build and install.
### Rule `["proto", "library"]`
-A proto library as abtract data structure.
+A proto library as abstract data structure.
- Such a libray does not produce any artifacts itself, but it can be used as a dependency for various language-specific rules.
+ Such a library does not produce any artifacts itself, but it can be used as a dependency for various language-specific rules.
| Field | Description |
| ----- | ----------- |
| `"stage"` | The directory to stage the source files to. Directory components are joined by `"/"`. |
| `"name"` | The name of the (abstract) library. |
-| `"service"` | If non empty, generate a service library (with acces sto `"rpc"` definitions) instead of a regular one. |
+| `"service"` | If non empty, generate a service library (with access to `"rpc"` definitions) instead of a regular one. |
| `"srcs"` | The proto files for this library |
| `"deps"` | Any other proto library this library depends on |
@@ -263,7 +263,7 @@ Replace a file, logically in place, by a patched version
| Field | Description |
| ----- | ----------- |
| `"patch-part"` | If the patch contains hunks for multiple files, only apply hunks for the specified file path. Individual directory components are joined with `"/"`. Note that the patch must be provided in unified format. |
-| `"src"` | The single source file to patch, typically an explict file reference. |
+| `"src"` | The single source file to patch, typically an explicit file reference. |
| `"patch"` | The patch to apply. |
### Rule `["CC/auto", "config"]`