From de441916d6e0e180a54f598ce0be3f8d7b5173e1 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 23:25:27 +0300 Subject: [PATCH] Add a comment to build instructions about cpplint I added a mention of `cpplint.py` in the build instructions. The reason, is because it's easy to miss it's existence. Even if you noticed it's mentioned in `coding-style.md` you might mistakenly think that `test.py` runs it). --- docs/development/build-instructions-linux.md | 12 ++++++++++-- docs/development/build-instructions-mac.md | 8 ++++++++ docs/development/build-instructions-windows.md | 8 ++++++++ 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 3fe3b53c21..6f4ce4e146 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -106,8 +106,8 @@ Make sure you have installed all the build dependencies. ### error while loading shared libraries: libtinfo.so.5 -Prebulit `clang` will try to link to `libtinfo.so.5`. Depending on the host architecture, -symlink to appropirate `libncurses` +Prebulit `clang` will try to link to `libtinfo.so.5`. Depending on the host +architecture, symlink to appropriate `libncurses` ```bash $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 @@ -115,6 +115,14 @@ $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 ## Tests +Test your changes confirm to the project coding style using: + +```bash +$ ./script/cpplint.py +``` + +Test functionality using: + ```bash $ ./script/test.py ``` diff --git a/docs/development/build-instructions-mac.md b/docs/development/build-instructions-mac.md index b0980a2312..af59f996f4 100644 --- a/docs/development/build-instructions-mac.md +++ b/docs/development/build-instructions-mac.md @@ -51,6 +51,14 @@ support 32bit OS X in future. ## Tests +Test your changes confirm to the project coding style using: + +```bash +$ ./script/cpplint.py +``` + +Test functionality using: + ```bash $ ./script/test.py ``` diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index 7f32b4645e..061011b5a1 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -67,6 +67,14 @@ The other building steps are exactly the same. ## Tests +Test your changes confirm to the project coding style using: + +```powershell +python script\cpplint.py +``` + +Test functionality using: + ```powershell python script\test.py ```