Gitiles
Code Review Sign In
realtimeroboticsgroup.org / RealtimeRoboticsGroup / test / d4aea1d47e2316e3924eff9b7baf95bce9dfab2f
commitd4aea1d47e2316e3924eff9b7baf95bce9dfab2f[log] [tgz]
authorBrian Silverman <brian@peloton-tech.com>Wed Dec 09 00:24:18 2015 -0500
committerBrian Silverman <brian@peloton-tech.com>Thu Dec 17 00:47:39 2015 -0500
tree32821da588430ef8837ea5cfa8441b07dd92f2fa
parent250eb4c31a282717bafe63f37d64b88f48d21108 [diff]
Add support for generating a compile_commands.json file for clang-tidy

Change-Id: I3db1a69030f6ba6617ccaf3a1ebc319111145fe1
6 files changed
tree: 32821da588430ef8837ea5cfa8441b07dd92f2fa
  1. aos/
  2. build_tests/
  3. debian/
  4. doc/
  5. frc971/
  6. third_party/
  7. tools/
  8. y2014/
  9. y2014_bot3/
  10. y2015/
  11. y2015_bot3/
  12. .clang-format
  13. .gitignore
  14. LICENSE.txt
  15. NO_BUILD_AMD64
  16. NO_BUILD_ROBORIO
  17. README.md
  18. WORKSPACE
README.md

Introduction

This is FRC Team 971's main code repository. There are README* files throughout the source tree documenting specifics for their respective folders.

Access to the code

The main central location for our code is our Gerrit server at https://robotics.mvla.net/gerrit. To get a copy of the code on your computer to work with, follow these steps:

  1. Contact Michael Schuh to get an SVN account.
  2. Go to Gerrit and create an account.
  3. Contact Brian Silverman with your SVN username to get access to the code in Gerrit.
  4. Go to the 971-Robot-Code project in Gerrit and run the command. Running the clone with commit-msg hook command will save you trouble later.

To learn more about git, see git(1) (man git or git(1) (especially the NOTES section).

Code reviews

We want all code to at least have a second person look over it before it gets merged into the master branch. Gerrit has extensive documentation on starting reviews. TL;DR: git push origin HEAD:refs/for/master and then click on the link. git-review can make the upload process simpler.

Building the code

The currently supported operating system for building the code is amd64 Debian Jessie. It is likely to work on any x86_64 GNU/Linux system, but that's not at all well-tested.

We use Bazel to build the code. Bazel has extensive docs and does a nice job with fast, correct increment rebuilds.

Steps to set up a computer to build the code: 0. Set up the required APT repositories: Download frc971.list and llvm.org.list and put them in /etc/apt/sources.list.d/.

  1. Install the required packages:
apt-get install python bazel ruby clang-format-3.5 clang-3.6
  1. Allow Bazel's sandboxing to work

Some useful Bazel commands:

  • Build and test everything (on the host system):
bazel test //... -- $(cat NO_BUILD_AMD64)
bazel build --cpu=roborio //... -- $(cat NO_BUILD_ROBORIO)

The NO_BUILD_{AMD64,ROBORIO} files contain lists of the targets which are intentionally not built for the various CPUs.
  • Build the code for a specific robot:
bazel build --cpu=roborio --compilation_mode=opt //y2015/...
  • Download code to a robot:
bazel run --cpu=roborio --compilation_mode=opt //y2015:download roboRIO-971.local