-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] Add how to set environment variables for fish users #1800
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTMig!
Plus 1 concern: will we add a explaination for each kind of shell including csh
, pwsh
, pysh
? My opinion is fish
users should know how to set environment variables (set -x
). If it's not used by majority, we'd better use some generic advices, e.g.: set TAICHI_REPO_DIR to the path to Taichi repo, no matter bash, zsh, fish, or even windows
.
docs/dev_install.rst
Outdated
set -x PYTHONPATH $TAICHI_REPO_DIR/python $PYTHONPATH | ||
set -x PATH $TAICHI_REPO_DIR/bin $PATH | ||
# set -x CXX /path/to/clang # Uncomment if you encounter issue about compiler in the next step. | ||
# set -x PATH /opt/llvm/bin $PATH # Uncomment if your llvm or clang is at somewhere else. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# set -x PATH /opt/llvm/bin $PATH # Uncomment if your llvm or clang is at somewhere else. | |
# set -x PATH /opt/llvm/bin:$PATH # Uncomment if your llvm or clang is at somewhere else. |
Not super sure about fish
, is this intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! This is intentional. See fish-shell/fish-shell#527 (comment) for an example.
Codecov Report
@@ Coverage Diff @@
## master #1800 +/- ##
==========================================
+ Coverage 42.45% 43.43% +0.98%
==========================================
Files 44 44
Lines 6202 6011 -191
Branches 1073 1075 +2
==========================================
- Hits 2633 2611 -22
+ Misses 3414 3246 -168
+ Partials 155 154 -1
Continue to review full report at Codecov.
|
Your concern is right. I've read some documentations (e.g. nvm), which include variations of different shells for users’ convenience. But this practice will make our documentation long-winded. So I shorten the description, including the possible pitfall only. |
Co-authored-by: 彭于斌 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM now.
🙋♂️ Hi, I'm a fish user and encountered a small problem when I was adding environment variables. So I added this part to the documentation. Hope it helps other fish users.