Fuchsia uses the jiri tool to manage git repositories
fuchsia.googlesource.com/jiri.
This tool manages a set of repositories specified by a manifest.
See Source code layout for an overview of how the code is organized.
For how to build, see Fuchsia's Getting Started doc.
Creating a new checkout
The bootstrap procedure requires that you have Go 1.6 or newer and Git installed and on your PATH.
This script will bootstrap a development environment for by first creating
directories fuchsia.
curl -s "https://fuchsia.googlesource.com/fuchsia/+/master/scripts/bootstrap?format=TEXT" | base64 --decode | bash
This script will set up your development environment to track the HEAD of the
fuchsia repository. If you wish to track a different repository at HEAD, you can
use the fx set-petal command.
Setting up environment variables
Upon success, the bootstrap script should print a message recommending that you
add the .jiri_root/bin directory to your PATH. This will add jiri to your
PATH, which is recommended and is assumed by other parts of the Fuchsia
toolchain.
Another tool in .jiri_root/bin is fx, which helps configuring, building,
running and debugging Fuchsia. See fx help for all available commands.
You can also source scripts/fx-env.sh, but sourcing fx-env.sh is not
required. It defines a few environment variables that are commonly used in the
documentation, such as $FUCHSIA_DIR, and provides useful shell functions, for
instance fd to change directories effectively. See comments in
scripts/fx-env.sh for more details.
Working without altering your PATH
If you don't like having to mangle your environment variables, and you want
jiri to "just work" depending on your current working directory, just copy
jiri into your PATH. However, you must have write access (without sudo)
to the directory into which you copy jiri. If you don't, then jiri
will not be able to keep itself up-to-date.
cp .jiri_root/bin/jiri ~/bin
To use the fx tool, you can either symlink it into your ~/bin directory:
ln -s `pwd`/scripts/fx ~/bin
or just run the tool directly as scripts/fx. Make sure you have jiri in
your PATH.
Who works on the code
In the root of every repository and in many other directories are OWNERS files. These list email addresses of individuals who are familiar with and can provide code review for the contents of the containing directory. See owners.md for more discussion.
How to handle third-party code
See the guidelines on writing the metadata for third-party code in README.fuchsia files.
Troubleshooting
Authentication errors
If you see an error when you check out the code warning you about Invalid authentication credentials, you likely have a cookie in your
$HOME/.gitcookies file that applies to repositories that jiri tries to check
out anonymously (likely in the domain .googlesource.com). You can follow the
onscreen directions to get passwords for the specific repositories, or you can
delete the offending cookie from your .gitcookies file.
