You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -18,7 +18,7 @@ If you’ve found a bug, please file an issue that illustrates the bug with a mi
18
18
19
19
### Pull request process
20
20
21
-
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("r-lib/cpp11", fork = TRUE)`.
21
+
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("r-lib/cpp4r", fork = TRUE)`.
22
22
23
23
* Install all development dependences with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
24
24
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
@@ -42,6 +42,6 @@ If you’ve found a bug, please file an issue that illustrates the bug with a mi
42
42
43
43
## Code of Conduct
44
44
45
-
Please note that the cpp11 project is released with a
45
+
Please note that the cpp4r project is released with a
46
46
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
Copy file name to clipboardExpand all lines: .github/SUPPORT.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Getting help with cpp11
1
+
# Getting help with cpp4r
2
2
3
-
Thanks for using cpp11!
3
+
Thanks for using cpp4r!
4
4
Before filing an issue, there are a few places to explore and pieces to put together to make the process as smooth as possible.
5
5
6
6
## Make a reprex
@@ -16,12 +16,12 @@ Armed with your reprex, the next step is to figure out [where to ask](https://ww
16
16
17
17
* If it's a question: start with [community.rstudio.com](https://community.rstudio.com/), and/or StackOverflow. There are more people there to answer questions.
18
18
19
-
* If it's a bug: you're in the right place, [file an issue](https://github.com/r-lib/cpp11/issues/new).
19
+
* If it's a bug: you're in the right place, [file an issue](https://github.com/r-lib/cpp4r/issues/new).
20
20
21
21
* If you're not sure: let the community help you figure it out!
22
22
If your problem _is_ a bug or a feature request, you can easily return here and report it.
23
23
24
-
Before opening a new issue, be sure to [search issues and pull requests](https://github.com/r-lib/cpp11/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
24
+
Before opening a new issue, be sure to [search issues and pull requests](https://github.com/r-lib/cpp4r/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
25
25
By default, the search will be pre-populated with `is:issue is:open`.
26
26
You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed.
27
27
For example, you'd simply remove `is:open` to search _all_ issues in the repo, open or closed.
The state of cpp11 is pretty stable, it seems to have the features we need for most of our projects using C++.
3
+
The state of cpp4r is pretty stable, it seems to have the features we need for most of our projects using C++.
4
4
5
5
## Known outstanding issues
6
6
7
-
### Running the cpp11test tests
7
+
### Running the cpp4rtest tests
8
8
9
-
Most of the test suite is in a sub-package, cpp11test.
10
-
The best way to run these tests is to install the development version of cpp11 after any change, and then run `devtools::test("./cpp11test")`.
9
+
Most of the test suite is in a sub-package, cpp4rtest.
10
+
The best way to run these tests is to install the development version of cpp4r after any change, and then run `devtools::test("./cpp4rtest")`.
11
11
Precisely, this looks like:
12
12
13
13
```r
14
-
# Install dev cpp11, clean the cpp11test dll manually since it thinks nothing
14
+
# Install dev cpp4r, clean the cpp4rtest dll manually since it thinks nothing
15
15
# has changed, then recompile and run its tests.
16
16
devtools::install()
17
-
devtools::clean_dll("./cpp11test")
18
-
devtools::test("./cpp11test")
17
+
devtools::clean_dll("./cpp4rtest")
18
+
devtools::test("./cpp4rtest")
19
19
```
20
20
21
21
If tests failures occur the output from Catch isn't always easy to interpret.
22
22
I have a branch of testthat https://github.com/jimhester/testthat/tree/catch-detailed-output that should make things easier to understand.
23
23
I contributed those changes to the main testthat, but something changed after merging the more detailed output was lost, I unfortunately never had the time to track down the cause and fix it.
24
24
25
-
In addition getting a debugger to catch when errors happen can be fiddly when running the cpp11test tests, something about the way that Catch redirects stderr / stdout interacts with the debugger.
25
+
In addition getting a debugger to catch when errors happen can be fiddly when running the cpp4rtest tests, something about the way that Catch redirects stderr / stdout interacts with the debugger.
26
26
27
-
The GitHub Actions workflow has some additional logic to handle running the cpp11 tests https://github.com/r-lib/cpp11/blob/fd8ef97d006db847f7f17166cf52e1e0383b2d35/.github/workflows/R-CMD-check.yaml#L95-L102, https://github.com/r-lib/cpp11/blob/fd8ef97d006db847f7f17166cf52e1e0383b2d35/.github/workflows/R-CMD-check.yaml#L117-L124.
27
+
The GitHub Actions workflow has some additional logic to handle running the cpp4r tests https://github.com/r-lib/cpp4r/blob/fd8ef97d006db847f7f17166cf52e1e0383b2d35/.github/workflows/R-CMD-check.yaml#L95-L102, https://github.com/r-lib/cpp4r/blob/fd8ef97d006db847f7f17166cf52e1e0383b2d35/.github/workflows/R-CMD-check.yaml#L117-L124.
28
28
29
-
## Ensure you use `Sys.setenv("CPP11_EVAL" = "true"); devtools::submit_cran()` when submitting.
29
+
## Ensure you use `Sys.setenv("cpp4r_EVAL" = "true"); devtools::submit_cran()` when submitting.
30
30
31
31
If you forget to set `CPP_EVAL = "true"` then the vignette chunks will not run properly and the vignettes will not be rendered properly.
32
32
33
33
## Regenerating benchmark objects used in `motivations.Rmd`
34
34
35
-
If you need to regenerate the benchmark objects (RDS objects) utilized in `motivations.Rmd`, then you should set `Sys.setenv("CPP11TEST_SHOULD_RUN_BENCHMARKS" = "TRUE")` before running the Rmd. You'll also need to make sure that cpp11test is actually installed. See `cpp11test:::should_run_benchmarks()` for more.
35
+
If you need to regenerate the benchmark objects (RDS objects) utilized in `motivations.Rmd`, then you should set `Sys.setenv("cpp4rTEST_SHOULD_RUN_BENCHMARKS" = "TRUE")` before running the Rmd. You'll also need to make sure that cpp4rtest is actually installed. See `cpp4rtest:::should_run_benchmarks()` for more.
36
36
37
37
## Usage with clangd
38
38
39
-
Since cpp11 is header only, if you use clangd you'll have a bit of an issue because tools like bear and pkgload won't know how to generate the `compile_commands.json` file. Instead, you can create it manually with something like this, which seems to work well. Note that the paths are specific to your computer.
39
+
Since cpp4r is header only, if you use clangd you'll have a bit of an issue because tools like bear and pkgload won't know how to generate the `compile_commands.json` file. Instead, you can create it manually with something like this, which seems to work well. Note that the paths are specific to your computer.
- Only doing this for `R.hpp` seems to be enough. I imagine this could be any of the header files, but it is reasonable to pick the "root" one that pretty much all others include.
54
54
- Using `-std=gnu++11` to keep us honest about only C++11 features.
55
55
- Using `-I\"/Library/Frameworks/R.framework/Resources/include\"` for access to the R headers.
56
-
- Using `-I\"/Users/davis/files/r/packages/cpp11/inst/include\"` as a "self include", which seems to be the key to the whole thing.
56
+
- Using `-I\"/Users/davis/files/r/packages/cpp4r/inst/include\"` as a "self include", which seems to be the key to the whole thing.
57
57
58
58
If you are modifying any tests or benchmarks, you also need:
59
59
@@ -66,6 +66,6 @@ Note that this is specific to a path on your machine and the R version you are c
66
66
67
67
Some work could be spent in smoothing out the `cpp_source()` / knitr chunk experience.
68
68
Our main focus and use cases were in R packages, so that usage is more tested.
69
-
Because we don't typically use cpp11 in non package contexts those use cases may not be as nice.
69
+
Because we don't typically use cpp4r in non package contexts those use cases may not be as nice.
70
70
71
71
For similar reasons the matrix support might be somewhat lacking, as the majority of our use cases do not deal with numeric matrices.
0 commit comments