Skip to content

Commit f5f3707

Browse files
Improve help text for plugin configuration options (#43)
Make the help text a bit more accurate/descriptive and fix a couple of syntax errors causing warnings from Please.
1 parent 24a8ea1 commit f5f3707

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Diff for: .plzconfig

+16-16
Original file line numberDiff line numberDiff line change
@@ -16,93 +16,93 @@ ConfigKey = Coverage
1616
DefaultValue = true
1717
Type = bool
1818
Inherit = true
19-
Help = Whether to build with coverage
19+
Help = If true, generates a "cover" build configuration for c_test and cc_test that outputs coverage analysis alongside test results.
2020

2121
[PluginConfig "coverage_tool"]
2222
ConfigKey = CoverageTool
2323
DefaultValue = gcov
2424
Inherit = true
25-
Help = The path or build target for the C coverage analysis tool
25+
Help = The path or build target for the C coverage analysis tool.
2626

2727
[PluginConfig "cc_tool"]
2828
ConfigKey = CCTool
2929
DefaultValue = gcc
3030
Inherit = true
31-
Help = The path or build label for the C compiler
31+
Help = The path or build target for the C compiler tool.
3232

3333
[PluginConfig "cpp_tool"]
3434
ConfigKey = CPPTool
3535
DefaultValue = g++
3636
Inherit = true
37-
Help = The path or build label for the C++ compiler
37+
Help = The path or build target for the C++ compiler tool.
3838

3939
[PluginConfig "ld_tool"]
4040
ConfigKey = LDTool
4141
DefaultValue = ld
4242
Inherit = true
43-
Hel- = The path or build label for the linker
43+
Help = The path or build target for the linker tool.
4444

4545
[PluginConfig "ar_tool"]
4646
ConfigKey = ARTool
4747
DefaultValue = ar
4848
Inherit = true
49-
Hel- = The path or build label for the archiver
49+
Help = The path or build target for the archiver tool.
5050

5151
[PluginConfig "default_opt_cflags"]
5252
ConfigKey = DefaultOptCFlags
5353
DefaultValue = --std=c99 -O3 -pipe -DNDEBUG -Wall -Werror
5454
Inherit = true
55-
Help = The default c compiler flags when compiling for release
55+
Help = The default flags to pass to the C compiler when compiling a release build.
5656

5757
[PluginConfig "default_dbg_cflags"]
5858
ConfigKey = DefaultDbgCFlags
5959
DefaultValue = --std=c99 -g3 -pipe -DDEBUG -Wall -Werror
6060
Inherit = true
61-
Help = The default c compiler flags when compiling for debug
61+
Help = The default flags to pass to the C compiler when compiling a debug build.
6262

6363
[PluginConfig "default_opt_cppflags"]
6464
ConfigKey = DefaultOptCppFlags
6565
DefaultValue = --std=c++11 -O3 -pipe -DNDEBUG -Wall -Werror
6666
Inherit = true
67-
Help = The default c++ compiler flags when compiling for release
67+
Help = The default flags to pass to the C++ compiler when compiling a release build.
6868

6969
[PluginConfig "default_dbg_cppflags"]
7070
ConfigKey = DefaultDbgCppFlags
7171
DefaultValue = --std=c++11 -g3 -pipe -DDEBUG -Wall -Werror
7272
Inherit = true
73-
Help = The default c++ compiler flags when compiling for debug
73+
Help = The default flags to pass to the C++ compiler when compiling a debug build.
7474

7575
[PluginConfig "default_ldflags"]
7676
ConfigKey = DefaultLdFlags
7777
DefaultValue = -lpthread -ldl
7878
Inherit = true
79-
Help = The default set of flags to apply when linking
79+
Help = The default flags to pass to the linker.
8080

8181
[PluginConfig "pkg_config_path"]
8282
ConfigKey = PkgConfigPath
8383
DefaultValue =
8484
Inherit = true
85-
Help = A path to the systems package configs
85+
Help = A path in which pkg-config should search for .pc files. This is used whenever the pkg_config_libs or pkg_config_cflags parameters are passed to the plugin's build rules.
8686

8787
[PluginConfig "test_main"]
8888
ConfigKey = TestMain
8989
Inherit = true
9090
DefaultValue = //unittest-pp:main
91-
Help = A build label with c/c++ source code to use run tests.
91+
Help = A build target for the source code that defines the entry point for C++ tests (see the cc_test build rule).
9292

9393
[PluginConfig "dsym_tool"]
9494
ConfigKey = DsymTool
9595
Inherit = true
9696
DefaultValue =
97-
Help = Set this to dsymutil or equivalent on MacOS to use this tool to generate xcode symbol information for debug builds.
97+
Help = The path or build target for dsymutil. If set, a .dSYM file containing symbol information is additionally outputted when compiling a debug build.
9898

9999
[PluginConfig "asm_tool"]
100100
ConfigKey = AsmTool
101101
DefaultValue = nasm
102102
Inherit = true
103-
Help = The tool to use for assembling assembly code
103+
Help = The path or build target for the assembler tool.
104104

105105
[PluginConfig "default_namespace"]
106106
ConfigKey = DefaultNamespace
107107
DefaultValue =
108-
Help = The default namespace to compile c++ code in
108+
Help = The default namespace in which to compile C++ code.

0 commit comments

Comments
 (0)