[build website]patch docs #77
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hturner
reviewed
Aug 29, 2023
docs/tutorials/patch_update.md
Outdated
Comment on lines
7
to
13
| If necessary, update R-devel | ||
|
|
||
| ```bash | ||
| cd $TOP_SRCDIR | ||
| svn update | ||
| cd $BUILDDIR | ||
| make # this will run the configure as before |
There was a problem hiding this comment.
I think we need to update this for the new $TOP_SRCDIR and $BUILDDIR. I suggest we always use "R-devel" as the default name for the built version
Suggested change
| If necessary, update R-devel | |
| ```bash | |
| cd $TOP_SRCDIR | |
| svn update | |
| cd $BUILDDIR | |
| make # this will run the configure as before | |
| If necessary, update the version of R you are working on, with the latest changes in <https://svn.r-project.org/R/trunk/>. E.g., if the version of R you are working on is named "R-devel-working" | |
| ```bash | |
| cd $TOP_SRCDIR/R-devel-working | |
| svn update | |
| cd $BUILDDIR/R-devel-working | |
| make # this will run the configure as before |
hturner
reviewed
Aug 30, 2023
| 3. Then create a patch | ||
|
|
||
| ```bash | ||
| cd "$TOP_SRCDIR" |
There was a problem hiding this comment.
Suggested change
| cd "$TOP_SRCDIR" | |
| cd "$TOP_SRCDIR/R-devel-working" |
docs/tutorials/patch_update.md
Outdated
| ```bash | ||
| cd "$TOP_SRCDIR" | ||
| svn update | ||
| svn diff > patch.diff |
There was a problem hiding this comment.
Suggested change
| svn diff > patch.diff | |
| svn diff > $PATCHDIR/patch.diff |
docs/tutorials/patch_update.md
Outdated
Comment on lines
31
to
35
| This is not ideal though as the patch file will be in $TOP_SRCDIR and we want to keep that clean. Also we want our patches easy to find. Perhaps we can also define a PATCHDIR? | ||
|
|
||
| PATCHDIR=/workspaces/r-dev-env/patches | ||
| mkdir $PATCHDIR | ||
| svn diff > $PATCHDIR/patch.diff |
There was a problem hiding this comment.
This part doesn't need to be in documentation. Instead
- Define the PATCHDIR env variable in the Docker container
- Make the corresponding directory when the container is created - put it in the bash script or use PostCreateCommand?
|
|
||
| #### 1) Change Directory to TOP_SRCDIR | ||
|
|
||
| If you are currently inside the BUILDDIR directory or root directory(/workspaces/r-dev-env) make sure to change it to TOP_SRCDIR so that we can update the changes made inside our source code. |
There was a problem hiding this comment.
Suggested change
| If you are currently inside the BUILDDIR directory or root directory(/workspaces/r-dev-env) make sure to change it to TOP_SRCDIR so that we can update the changes made inside our source code. | |
| If you are currently inside the BUILDDIR directory or root directory(/workspaces/r-dev-env) make sure to change it to the source directory for the version of R you are working on so that we can update the changes made inside our source code. For example, |
| If you are currently inside the BUILDDIR directory or root directory(/workspaces/r-dev-env) make sure to change it to TOP_SRCDIR so that we can update the changes made inside our source code. | ||
|
|
||
| ```bash | ||
| cd $TOP_SRCDIR |
There was a problem hiding this comment.
Suggested change
| cd $TOP_SRCDIR | |
| cd $TOP_SRCDIR/R-devel-working |
| To rebuild the R version and reflect on the changes made, we want to change directory to BUILDDIR from TOP_SRCDIR | ||
|
|
||
| ```bash | ||
| cd $BUILDDIR |
There was a problem hiding this comment.
Suggested change
| cd $BUILDDIR | |
| cd $BUILDDIR/R-devel-working |
Comment on lines
+64
to
+65
| make check | ||
| make |
There was a problem hiding this comment.
Suggested change
| make check | |
| make | |
| make | |
| make check |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR for issue no #40 #43
The patchdir should be mention in dockerfile!?