tree: 6addf744896e063b8645af8aeb4eeefd51acf249 [path history] [tgz]
  1. README.md
  2. format.sh
tool/code-format/README.md

How to format code

This guide is for singa devoloper who should sanitize the code before merging into the main branch.

tools to auto formating code

Install clang-format for C++:

Ubuntu 16.04: sudo apt install clang-format

Ubuntu 18.04: sudo apt install clang-format-6.0

Install yapf for Python:

pip install yapf

Formating a single file

  • C++: clang-format -i path/to/file

  • Python: yapf -i path/to/file

Formating the whole project

usage: bash tool/code-format/format.sh

Configuration:

Currently the configuration are customized to respect google style. Update of configuration could be done at .clang-format and .style.yapf