Skip to content

Commit

Permalink
update doc (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yuyawk
yuyawk authored Dec 21, 2024
1 parent 60deec0 commit 03f0fe8
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions lang/cc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ Defines some implementations to check build error in C/C++. Each of them can be

In addition to the common rule attributes listed [here](https://bazel.build/reference/be/common-definitions#common-attributes), it can receive the following attributes (regarding the specific matcher, please refer to [its readme](../../matcher/README.md)):

| Attribute | Description | Type | Is this attribute required? | Other constraints |
| ------------------------ | ------------------------------------------------------------------ | ---------------------------------------- | --------------------------- | --------------------------------------------------- |
| name | Name of the target. | str | Yes | |
| src | C/C++ source file to check build | label or [an inline source](#inline_src) | Yes | Must be a single file having an extension for C/C++ |
| additional_linker_inputs | Pass these files to the linker command | list of labels | No (defaults to `[]`) | |
| copts | C/C++ compilation options | list of str | No (defaults to `[]`) | |
| deps | The list of CcInfo libraries to be linked in to the binary target. | list of label | No (defaults to `[]`) | Each list element must provide `CcInfo` |
| linkopts | C/C++ linking options | list of str | No (defaults to `[]`) | |
| local_defines | Pre-processor macro definitions | list of str | No (defaults to `[]`) | |
| compile_stderr | Matcher for the stderr message while compiling | specific matcher | No (defaults to no-op) | |
| compile_stdout | Matcher for the stdout message while compiling | specific matcher | No (defaults to no-op) | |
| link_stderr | Matcher for the stderr message while linking | specific matcher | No (defaults to no-op) | |
| link_stdout | Matcher for the stdout message while linking | specific matcher | No (defaults to no-op) | |
| Attribute | Description | Type | Is this attribute required? | Other constraints |
| ------------------------ | ------------------------------------------------------------------ | ---------------------------------------- | --------------------------- | -------------------------------------------------------------------------- |
| name | Name of the target. | str | Yes | |
| src | C/C++ source file to check build | label or [an inline source](#inline_src) | Yes | Must be a single file having an extension for C/C++ when providing a label |
| additional_linker_inputs | Pass these files to the linker command | list of labels | No (defaults to `[]`) | |
| copts | C/C++ compilation options | list of str | No (defaults to `[]`) | |
| deps | The list of CcInfo libraries to be linked in to the binary target. | list of label | No (defaults to `[]`) | Each list element must provide `CcInfo` |
| linkopts | C/C++ linking options | list of str | No (defaults to `[]`) | |
| local_defines | Pre-processor macro definitions | list of str | No (defaults to `[]`) | |
| compile_stderr | Matcher for the stderr message while compiling | specific matcher | No (defaults to no-op) | |
| compile_stdout | Matcher for the stdout message while compiling | specific matcher | No (defaults to no-op) | |
| link_stderr | Matcher for the stderr message while linking | specific matcher | No (defaults to no-op) | |
| link_stdout | Matcher for the stdout message while linking | specific matcher | No (defaults to no-op) | |

### `CcBuildErrorInfo`

Expand Down

0 comments on commit 03f0fe8

Please sign in to comment.