Add environment variables documentation #2526
Conversation
|
Also all the file mode changes are incorrect; these files are supposed to be executable. |
SmartManoj
force-pushed
the
add-environment-variables
branch
from
beabc0b
to
1ae62d6
Compare
|
I've not looked at the most recent "fix erroneous change" commit, but the file modes seem still wrong. Note that when you use an AI tool, it is your responsibility to review the generated code and docs for obvious errors and not leave it to the PR reviewer to clean up after the tool! And while I don't think it is an issue here, it is also your responsibility to make sure you comply with the Generative AI Policy | Linux Foundation. |
For #2455 (comment), I amended with the first commit in Windows, and the diff shows file modes are changed. So, I thought Windows reverted the file modes but it seems it's the output of the first diff. |
The file mode for Also please squash commits and create a meaningful commit message! |
SmartManoj
force-pushed
the
add-environment-variables
branch
from
93ac0cb
to
7118626
Compare
$ git log --summary -1
commit 7118626d9b1d346c18c8a2b4f96ae25787a3b11e (HEAD -> add-environment-variables, origin/add-environment-variables)
Author: மனோஜ்குமார் பழனிச்சாமி <[email protected]>
Date: Fri Aug 2 10:47:17 2024 +0530
Add environment variables documentation
Signed-off-by: மனோஜ்குமார் பழனிச்சாமி <[email protected]>
create mode 100644 website/content/en/docs/config/environment-variables.md |
| export LIMA_SHELL=/bin/bash | ||
| lima | ||
| ``` | ||
| - **Used in**: `cmd/lima`, `cmd/limactl/shell.go` |
There was a problem hiding this comment.
I don't think this env var is used in cmd/limactl/shell.go.
Even if it was used, such an implementation detail would not need to be documented here.
There was a problem hiding this comment.
The same applies to other *.go source files
There was a problem hiding this comment.
.go files are mentioned here only. This PR is created mainly for this environment var only.
There was a problem hiding this comment.
The implementation details shouldn't be mentioned in user docs
There was a problem hiding this comment.
Which line are you referring to?
SmartManoj
force-pushed
the
add-environment-variables
branch
from
7118626
to
52d5b72
Compare
Signed-off-by: மனோஜ்குமார் பழனிச்சாமி <[email protected]>
SmartManoj
force-pushed
the
add-environment-variables
branch
from
52d5b72
to
9faad41
Compare
Created a new PR to avoid the blockage of #2455
Add documentation for environment variables used in Lima.
website/content/en/docs/config/environment-variables.mdto document environment variablesLIMA_INSTANCE,LIMA_SHELL,LIMA_WORKDIR,LIMACTL, andLIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT.website/content/en/docs/config/_index.mdto include a link to the new 'Environment Variables' page.README.mdto include a link to the new 'Environment Variables' page.cmd/lima: Add comments documentingLIMA_INSTANCE,LIMA_SHELL,LIMA_WORKDIR, andLIMACTL.cmd/lima.bat: Add comments documentingLIMA_INSTANCEandLIMACTL.cmd/docker.lima: Add comments documentingLIMA_INSTANCE.cmd/kubectl.lima: Add comments documentingLIMA_INSTANCE.cmd/limactl/usernet.go: Add comments documentingLIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT.For more details, open the Copilot Workspace session.