commit | 12c8fab72b34b2c3fa9380387b98e90acd9b7318 | [log] [tgz] |
---|---|---|
author | Shawn Pearce <sop@google.com> | Sun May 15 16:55:21 2016 -0700 |
committer | Shawn Pearce <sop@google.com> | Mon May 23 18:06:16 2016 -0700 |
tree | 9142ce43d885209d757e4ddbaea2099b21bc73b2 | |
parent | 1190ca6a5444ac3e47f4d1db008ea6541502d27b [diff] |
Switch to commonmark 0.5.0 Reasons to switch: * Supports the CommonMark[1] "standard" * Fewer dependencies * BSD 2-clause license * Fast (claims 10-20 times faster than pegdown) * Cleaner extension API than Pegdown * No timeout limit required Testing with Documentation/markdown.md: | cold vm | hot vm | +---------+--------| prior | 2.29s | 279ms | this | 1.64s | 139ms | Testing with Chromium's botmap.md: | cold vm | hot vm | +---------+--------| prior | 3.47s | 946ms | this | 1.83s | 257ms | Changes in Markdown from Pegdown: * No <<double angle>> quotes (confused with HTML). * No table captions (no [caption after table]). * Table columns are same width (no multi-column spans). * Smart quotes can no longer be disabled by \'. * Horizontal rule should be at least 3 -, e.g. ---. (However GitHub Flavor -- is still accepted.) [1] http://commonmark.org Change-Id: Ief189d0226901a284d9b86d9798310786ae1e983
Gitiles is a simple repository browser for Git repositories, built on JGit. Its guiding principle is simplicity: it has no formal access controls, no write access, no fancy Javascript, etc.
Gitiles requires Buck to build.
sudo apt-get install ant cd ${HOME} git clone https://github.com/facebook/buck.git cd buck ant sudo ln -s ${PWD}/bin/buck /usr/bin/buck cd /path/to/gitiles git submodule update --init buck build all buck test
cd /path/to/repositories # Don't run from the gitiles repo. /path/to/gitiles/tools/run_dev.sh
This will recompile and start a development server. Open http://localhost:8080/ to view your local copy of gitiles, which will serve any repositories under /path/to/repositories
.
To run unit tests, run buck test
.
If you'd like to use Eclipse to edit Gitiles, first generate a project file:
./bucklets/tools/eclipse.py --src
Import the project in Eclipse:
File -> Import -> Existing Projects into Workpace
The project only needs to be rebuilt if the source roots or third-party libraries have changed. For best results, ensure the project is closed in Eclipse before rebuilding.
Java code in Gitiles follows the Google Java Style Guide with a 100-column limit.
Code should be automatically formatted using google-java-format prior to sending a code review. There is currently no Eclipse formatter, but the tool can be run from the command line:
java -jar /path/to/google-java-format-1.0-all-deps.jar -i path/to/java/File.java
CSS in Gitiles follows the SUIT CSS naming conventions.
Gitiles uses Gerrit for code review: https://gerrit-review.googlesource.com/
Gitiles uses the “git push” workflow with server https://gerrit.googlesource.com/gitiles. You will need a generated cookie.
Gerrit depends on “Change-Id” annotations in your commit message. If you try to push a commit without one, it will explain how to install the proper git-hook:
curl -Lo `git rev-parse --git-dir`/hooks/commit-msg \ https://gerrit-review.googlesource.com/tools/hooks/commit-msg chmod +x `git rev-parse --git-dir`/hooks/commit-msg
Before you create your local commit (which you'll push to Gerrit) you will need to set your email to match your Gerrit account:
git config --local --add user.email foo@bar.com
Normally you will create code reviews by pushing for master:
git push origin HEAD:refs/for/master