Skip to content

Commit 4de7797

Browse files
committed
Remove git submodule from docs
1 parent 19a0a32 commit 4de7797

File tree

5 files changed

+8
-37
lines changed

5 files changed

+8
-37
lines changed

doc/faq/index_cn.rst

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -286,22 +286,3 @@ PaddlePaddle的参数使用名字 :code:`name` 作为参数的ID,相同名字
286286
.. code-block:: bash
287287
288288
paddle train --use_gpu=true --trainer_count=2 --gpu_id=2
289-
290-
12. 编译源码提示warp-ctc/include/ctc.h 找不到的情况
291-
---------------------------------------------------
292-
293-
目前Paddle使用\ :code:`git submodule`\ 来引用一些第三方模块。简单的\
294-
:code:`git clone`\ 命令不能得到第三方模块的代码。需要使用\:
295-
296-
.. code-block:: bash
297-
298-
git clone --recursive https://github.com/PaddlePaddle/Paddle.git
299-
300-
来获取所有源码。对于已经clone的git版本库,可以在Paddle的源码目录中执行\:
301-
302-
.. code-block:: bash
303-
304-
git submodule init
305-
git submodule update
306-
307-
来获得所有第三方模块。

doc/getstarted/build_and_install/build_from_source_en.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ cd paddle
1717
To compile the source code, your computer must be equipped with the following dependencies.
1818

1919
- **Compiler**: GCC >= 4.8 or Clang >= 3.3 (AppleClang >= 5.1)
20-
- **CMake**: version >= 3.0
20+
- **CMake**: version >= 3.0 (at least CMake 3.4 on Mac OS X)
2121
- **BLAS**: MKL, OpenBlas or ATLAS
2222

2323
**Note:** For CUDA 7.0 and CUDA 7.5, GCC 5.0 and up are not supported!
@@ -64,10 +64,13 @@ As a simple example, consider the following:
6464

6565
1. **BLAS Dependencies(optional)**
6666

67-
Paddle will find BLAS from system's default path. But you can specify MKL, OpenBLAS or ATLAS via `CBLAS_INC_DIR` and `CBLAS_LIBRARIES`.
67+
Paddle will find BLAS from system's default path. But you can specify MKL, OpenBLAS or ATLAS via `MKL_ROOT`, `OPENBLAS_ROOT` or `ATLAS_ROOT`.
6868

6969
```bash
70-
cmake .. -DCBLAS_INC_DIR=<cblas_inc> -DCBLAS_LIBRARIES=<cblas_libs>
70+
# specify MKL
71+
cmake .. -DMKL_ROOT=<mkl_path>
72+
# or specify OpenBLAS
73+
cmake .. -DOPENBLAS_ROOT=<openblas_path>
7174
```
7275

7376
2. **Doc Dependencies(optional)**

doc/getstarted/build_and_install/docker_install_en.rst

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,13 @@ Developers can work on PaddlePaddle using Docker. This allows
1616
developers to work on different platforms -- Linux, Mac OS X, and
1717
Windows -- in a consistent way.
1818

19-
The general development workflow with Docker and Bazel is as follows:
19+
The general development workflow with Docker and CMake is as follows:
2020

2121
1. Get the source code of Paddle:
2222

2323
.. code-block:: bash
2424
25-
git clone --recursive https://github.com/PaddlePaddle/Paddle.git
26-
27-
28-
Here **git clone --recursive is required** as we have a submodule `warp-ctc <https://github.com/baidu-research/warp-ctc>`_.
29-
30-
If you have used :code:`git clone https://github.com/PaddlePaddle/Paddle` and find that the directory :code:`warp-ctc` is
31-
empty, please use the following command to get the submodule.
32-
33-
.. code-block:: bash
34-
35-
git submodule update --init --recursive
25+
git clone https://github.com/PaddlePaddle/Paddle.git
3626
3727
3828
2. Build a development Docker image :code:`paddle:dev` from the source
@@ -162,7 +152,6 @@ source code:
162152
cd ~
163153
git clone https://github.com/PaddlePaddle/Paddle.git
164154
cd Paddle
165-
git submodule update --init --recursive
166155
docker build --build-arg WITH_AVX=OFF -t paddle:cpu-noavx -f paddle/scripts/docker/Dockerfile .
167156
docker build --build-arg WITH_AVX=OFF -t paddle:gpu-noavx -f paddle/scripts/docker/Dockerfile.gpu .
168157

doc/howto/dev/contribute_to_paddle_cn.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ cd Paddle
3333
git checkout -b develop # 创建 develop 分支
3434
git remote add upstream https://github.com/PaddlePaddle/Paddle.git # 添加 upstream 到 baidu/Paddle
3535
git pull upstream develop # 更新 upstream
36-
git submodule update --init --recursive
3736
```
3837

3938
然后你可以通过做一个本地开发分支开始开发

doc/howto/dev/contribute_to_paddle_en.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ cd Paddle
3838
git checkout -b develop # create develop branch.
3939
git remote add upstream https://github.com/PaddlePaddle/Paddle.git # add upstream to baidu/Paddle
4040
git pull upstream develop # update to upstream
41-
git submodule update --init --recursive
4241
```
4342

4443
Then you can start to develop by making a local developement branch

0 commit comments

Comments
 (0)