Make the target installation directory configurable via DTC_ROOT #1188
Conversation
✅ Deploy Preview for dtc-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Changed environment variable `DTC_ROOT` to be configurable specify the parent directory the installation directory, which defaults the value of the environment variable `HOME`.
obfischer
force-pushed
the
feature/custom-value-for-dtc-home
branch
from
9c380c5
to
a49fee5
Compare
| @@ -54,6 +54,7 @@ and this project tries to adhere to https://semver.org/spec/v2.0.0.html[Semantic | |||
| ** 'org.openapi.generator:6.6.0' | |||
| ** 'org.spockframework:spock-core:2.3-groovy-3.0' | |||
| * `dtcw` and `dtcw.ps1`: | |||
| ** Changed environment variable `DTC_ROOT` to be configurable specify the parent directory the installation directory, which defaults the value of the environment variable `HOME` | |||
There was a problem hiding this comment.
I introduced DTC_ROOT as prerequisite to address #1062. Since DTC_ROOT was not accessible until now, I would change the description a bit. What about:
"Add new environment variable DTC_ROOT to make the docToolchain installation directory configurable. The default installation directory remains $HOME/.docoolchain.
| docToolchain will be installed below the directory specified via the environment variable `DTC_ROOT`, which defaults to `$HOME`. | ||
| To install docToolchain in `$DTC_ROOT/.doctoolchain` execute the following command. |
There was a problem hiding this comment.
This is erroneous - check your code above. DTC_ROOT=${HOME}/.doctoolchain. I would rephrase the section above with something like:
"Using the wrapper script will install docToolchain into $HOME/.doctoolchain."
Your tip already provides all the information a user may need to change docToolchain's installation directory. So why explaining it redundantly.
There was a problem hiding this comment.
We should move this paragraph just after the header. The Windows wrapper script dtcw.ps1 has to be changed as well.
|
|
||
| [source, bash] | ||
| ---- | ||
| ./dtcw install doctoolchain | ||
| ---- | ||
|
|
||
| In case you have no Java installed you may use `dtcw` to install Java in a sub-directory of `$HOME/.doctoolchain`. | ||
| In case you have no Java installed you may use `dtcw` to install Java in a sub-directory of `$DTC_ROOT/.doctoolchain`. |
There was a problem hiding this comment.
Once again, DTC_ROOT points to $HOME/.doctoolchain. According to your documentation Java would be installed in $HOME/.doctoolchain/.doctoolchain.
Changed environment variable
DTC_ROOTto be configurable specify the parent directory the installation directory, which defaults the value of the environment variableHOME.All Submissions:
changelog.adoc?The source of the documentation can be found in
/src/docs/.If you didn't find the time to update docs, please create an issue as reminder to do so.
Your first submission
inspiration: https://github.com/stevemao/github-issue-templates