Skip to content

Commit 9be5ecb

Browse files
Correcting and updating documentations
1 parent 8cae7c9 commit 9be5ecb

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

mkdocs/docs/TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
- Add the ability to query script build directory
3434
- Add the ability to list script dependencies
3535

36-
## Not planned yet
36+
## Planned But Low Priority
3737

3838
- Smoother CMake support by reading cmake target properties (https://stackoverflow.com/a/56738858/23479578)
3939
- Add the ability to specify different profiles(?)/defines for different source files

mkdocs/docs/guides/basic_concepts.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,12 @@ Most build settings in runcpp2 follow this structure:
7373
OverrideCompileFlags:
7474
Windows:
7575
"g++":
76-
Flags: "-O2 -Wall"
76+
Append: "-O2 -Wall"
7777
"msvc":
78-
Flags: "/O2"
78+
Append: "/O2"
7979
Linux:
8080
"g++":
81-
Flags: "-O3"
81+
Append: "-O3"
8282
```
8383

8484
There are two special keywords for more flexible configuration:
@@ -92,9 +92,9 @@ There are two special keywords for more flexible configuration:
9292
OverrideCompileFlags:
9393
DefaultPlatform:
9494
DefaultProfile:
95-
Flags: "-Wall"
95+
Append: "-Wall"
9696
"g++":
97-
Flags: "-O2"
97+
Append: "-O2"
9898
```
9999
When using g++, only `-O2` will be used, not `-Wall -O2`.
100100
When using any other profile, only `-Wall` will be used.
@@ -106,12 +106,12 @@ There are two special keywords for more flexible configuration:
106106
For example:
107107
```yaml
108108
OverrideCompileFlags:
109-
Flags: "-Wall"
109+
Append: "-Wall"
110110
```
111111
is equivalent to:
112112
```yaml
113113
OverrideCompileFlags:
114114
DefaultPlatform:
115115
DefaultProfile:
116-
Flags: "-Wall"
116+
Append: "-Wall"
117117
```

mkdocs/docs/guides/building_project_sources.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ All paths are relative to the script file's location.
9898

9999
### Globbing Source Files
100100

101-
**WIP**
101+
**Coming Soon**. See [Roadmap](../TODO.md)
102102

103103
### Mixing C And C++ Files
104104

@@ -233,4 +233,5 @@ runcpp2 provides four types of command hooks that run at different stages of the
233233
---
234234

235235
## Intellisense and language server support
236-
**WIP**
236+
237+
**Coming Soon**. See [Roadmap](../TODO.md)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Scriptable Pipeline
22

3-
**WIP**
3+
**Coming Soon**. See [Roadmap](../TODO.md)

0 commit comments

Comments
 (0)