From a6292f2d02c17e6419c9e30910c639cea796c7c5 Mon Sep 17 00:00:00 2001 From: chengluyu Date: Fri, 28 Aug 2020 20:39:02 +0800 Subject: [PATCH 1/3] [doc]: Add how to set environment variables for fish users --- docs/dev_install.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/dev_install.rst b/docs/dev_install.rst index 5f5f5f7c8a290..6600979e1e9d4 100644 --- a/docs/dev_install.rst +++ b/docs/dev_install.rst @@ -116,6 +116,17 @@ Setting up Taichi for development Then execute ``source ~/.bashrc`` to reload shell config. + If you're using fish. Use ``set -x`` to set environment variables. Execute following commands + or add them to ``~/.config/fish/config.fish`` (create if it doesn't exist). + + .. code-block:: fish + + set -x TAICHI_REPO_DIR /path/to/taichi + 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. + * On Windows, please add these variables by accessing your system settings: 1. Add ``TAICHI_REPO_DIR`` whose value is the path to your taichi repository so that Taichi knows you're a developer. From c56e8af8ce39c520cc19b5a0455e95dc07834e14 Mon Sep 17 00:00:00 2001 From: chengluyu Date: Fri, 28 Aug 2020 22:26:01 +0800 Subject: [PATCH 2/3] [doc] shorten the description for fish users --- docs/dev_install.rst | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/docs/dev_install.rst b/docs/dev_install.rst index 6600979e1e9d4..23d426682fdb7 100644 --- a/docs/dev_install.rst +++ b/docs/dev_install.rst @@ -116,16 +116,7 @@ Setting up Taichi for development Then execute ``source ~/.bashrc`` to reload shell config. - If you're using fish. Use ``set -x`` to set environment variables. Execute following commands - or add them to ``~/.config/fish/config.fish`` (create if it doesn't exist). - - .. code-block:: fish - - set -x TAICHI_REPO_DIR /path/to/taichi - 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. + If you're using fish, use ``set -x NAME VALUES``, otherwise it won't be loaded by child processes. * On Windows, please add these variables by accessing your system settings: From 7012d8711d9901c0b46236084cc3e1b588de7819 Mon Sep 17 00:00:00 2001 From: Luyu Cheng Date: Fri, 28 Aug 2020 22:53:21 +0800 Subject: [PATCH 3/3] [doc] enclose fish descriptions with note MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: 彭于斌 <1931127624@qq.com> --- docs/dev_install.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/dev_install.rst b/docs/dev_install.rst index 23d426682fdb7..c448fac3aba14 100644 --- a/docs/dev_install.rst +++ b/docs/dev_install.rst @@ -116,7 +116,9 @@ Setting up Taichi for development Then execute ``source ~/.bashrc`` to reload shell config. - If you're using fish, use ``set -x NAME VALUES``, otherwise it won't be loaded by child processes. + .. note:: + + If you're using fish, use ``set -x NAME VALUES``, otherwise it won't be loaded by child processes. * On Windows, please add these variables by accessing your system settings: