Gitiles
Code Review Sign In
realtimeroboticsgroup.org / RealtimeRoboticsGroup / test / 6804a8533abd41f3cb030d20f02ee03bb86b6144
commit6804a8533abd41f3cb030d20f02ee03bb86b6144[log] [tgz]
authorBrian Silverman <brian@peloton-tech.com>Sun Oct 11 01:43:33 2015 -0400
committerBrian Silverman <brians>Sat Oct 31 20:20:56 2015 -0400
tree926c9326880d9deeecd3ccecf5ffc94edc1f474f
parent281bf302bde2c18b34a764f30ffe45b01faeb813 [diff]
Update docs

A lot of the documentation was completely outdated. There's less total
documentation now because a lot of what we do has gotten a lot simpler
and so requires less documentation.

Change-Id: I6c862472aef167fcd3d5e877a1c83715b3caeb20
6 files changed
tree: 926c9326880d9deeecd3ccecf5ffc94edc1f474f
  1. aos/
  2. bot3/
  3. build_tests/
  4. debian/
  5. doc/
  6. frc971/
  7. output/
  8. third_party/
  9. tools/
  10. y2014/
  11. y2015/
  12. opt_bazel_base_workspace ⇨ /opt/bazel/base_workspace/
  13. .clang-format
  14. .gitignore
  15. README.md
  16. 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 //...

This currently requires adding `-//{y2014,y2015,bot3,frc971}/wpilib/... -//aos/externals:wpilib` to avoid trying to build WPILib to work.
  • 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/prime:download roboRIO-971.local