Skip to content

Commit 43e34d1

Browse files
committed
Update Blog “help-us-prioritize-features-for-future-releases-of-chapel”
1 parent 3b6ddc9 commit 43e34d1

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed

content/blog/help-us-prioritize-features-for-future-releases-of-chapel.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ disable: false
77
tags:
88
- Chapel
99
---
10+
<style>
11+
li {
12+
font-size: 27px;
13+
line-height: 33px;
14+
max-width: none;
15+
}
16+
</style>
17+
1018
In a [recent blog post](https://chapel-lang.org/blog/posts/announcing-chapel-1.32/), the Chapel team gave a preview of Chapel 1.32, the release candidate for the official 2.0 version which will declare a core subset of the language and library features as "stable". These features are ones that we intend to support in their current form going forward, such that code relying on them will not break across releases.
1119

1220
With this candidate release available, we thought now would be a good time to get a sense for what remaining currently unstable features are important to our user base, so that we can better prioritize what to stabilize next. To do so, we've created a Chapel program ([available here](https://github.com/chapel-lang/chapel/blob/main/tools/unstableWarningAnonymizer/unstableAnonScript.chpl)) that will summarize the unstable warnings in your key programs. This summary will not include any identifying details like module or variable names, so even if your source code is not intended for public eyes, you should be able to send us the result of running this script without worry.
@@ -17,66 +25,56 @@ Here's how to use this script:
1725

1826
1. Compile the program linked above like you would any normal Chapel program. This should create an executable named 'unstableAnonScript'. For example:
1927

20-
````markdown
28+
```markdown
29+
chpl unstableAnonScript.chpl
2130
```
22-
> chpl unstableAnonScript.chpl
23-
```
24-
````
2531

26-
1. Compile and run your program as you would normally, with the addition of the compilation flag `--warn-unstable` (which will cause any use of unstable features to trigger a warning), and save the full output into a file.
32+
2. Compile and run your program as you would normally, with the addition of the compilation flag `--warn-unstable` (which will cause any use of unstable features to trigger a warning), and save the full output into a file.
2733

28-
````markdown
34+
```markdown
35+
chpl --warn-unstable myProgram.chpl >myUnstableOutput.txt 2>&1
36+
./myProgram >>myUnstableOutput.txt 2>&1
2937
```
30-
> chpl --warn-unstable myProgram.chpl >myUnstableOutput.txt 2>&1 > ./myProgram >>myUnstableOutput.txt 2>&1
31-
```
32-
````
3338

34-
1. After these commands, `myUnstableOutput.txt` (or whatever you've named it) should contain any unstable warnings you may trigger in your code, as well as any other potential output that occurs when compiling and running your program.
39+
After these commands, `myUnstableOutput.txt` (or whatever you've named it) should contain any unstable warnings you may trigger in your code, as well as any other potential output that occurs when compiling and running your program.
3540

36-
Run the built script over your output file. For our convenience, it would be helpful to run with the `--csv` and `--sorted` flags, or `-c` and `-d` if you want to use the shorter version of those flags.
41+
3. Run the built script over your output file. For our convenience, it would be helpful to run with the `--csv` and `--sorted` flags, or `-c` and `-d` if you want to use the shorter version of those flags.
3742

38-
````markdown
39-
```
40-
> ./unstableAnonScript --csv --sorted --inputFiles myUnstableOutput.txt --outputFile mySummary.csv
43+
```markdown
44+
./unstableAnonScript --csv --sorted --inputFiles myUnstableOutput.txt --outputFile mySummary.csv
4145
```
4246

4347
or
4448

49+
```markdown
50+
./unstableAnonScript -c -d -i myUnstableOutput.txt -o mySummary.csv
4551
```
46-
> ./unstableAnonScript -c -d -i myUnstableOutput.txt -o mySummary.csv
47-
```
48-
49-
````
52+
5053

5154
Note that `--inputFiles`/`-i` can take multiple files, so if you have multiple chapel programs you'd like to share the results for, you can combine the results together by specifying the unstable warnings from all of those programs at the same time:
5255

53-
````markdown
56+
```markdown
57+
./unstableAnonScript -c -d -n -i myUnstableOutput1.txt myUnstableOutput2.txt myUnstableOutput3.txt -o mySummary.csv
5458
```
55-
> ./unstableAnonScript -c -d -n -i myUnstableOutput1.txt myUnstableOutput2.txt myUnstableOutput3.txt -o mySummary.csv
56-
```
57-
````
5859

5960
After any of these commands, `mySummary.csv` (or whatever you've named
6061
it) should contain a comma-separated list of the unstable warnings generated by your program(s) and their counts, sorted from most common to least. There should be no identifying information in this file, so at this point, it should be safe to send the file to us.
6162

6263
You could also additionally run with the `--numFiles` flag (`-n` for short), which will include the number of different files where each unstable warning was generated:
6364

64-
````markdown
65-
```
66-
> ./unstableAnonScript --csv --sorted --numFiles --inputFiles myUnstableOutput.txt --outputFile mySummary.csv
65+
```markdown
66+
./unstableAnonScript --csv --sorted --numFiles --inputFiles myUnstableOutput.txt --outputFile mySummary.csv
6767
```
6868

6969
Or
7070

71+
```markdown
72+
./unstableAnonScript -c -d -n -i myUnstableOutput.txt -o mySummary.csv
7173
```
72-
> ./unstableAnonScript -c -d -n -i myUnstableOutput.txt -o mySummary.csv
73-
```
74-
75-
````
7674

7775
This information would be helpful for our metrics, but is not essential.
7876

79-
Please send your resulting file to chapel[email protected]. If you would like to send it to just the Chapel team at HPE, you can either send it to the [Chapel team at Discourse](https://chapel.discourse.group/c/info/16) or to [Lydia Duncan at Discourse ](https://chapel.discourse.group/u/lydia)directly. Note that if you do not already have a Discourse account, you may be asked to create one to send it.
77+
Please send your resulting file to [chapel users mailing list on Discourse](https://chapel.discourse.group/c/users/6). If you would like to send it to just the Chapel team at HPE, you can either send it to the [[email protected]](mailto:chapel+info@discoursemail.com) or to [Lydia Duncan at Discourse](https://chapel.discourse.group/u/lydia) directly. Note that if you do not already have a Discourse account, you may be asked to create one to send it.
8078

8179
If you have any questions or concerns about this, please don't hesitate to voice them.
8280

0 commit comments

Comments
 (0)