starlingx/docs
Code Issues Proposed changes
d8ebebe083
docs/doc/source/developer_resources/navigate_source_code.rst
Dominig ar Foll Intel Open Source 783886f365 initial creation Doc page Navigate Git Code story/2005184 
- Standardize formatting
- Minor grammatical edits
- Spelling

Change-Id: I2c0a491d1adf0584cd862d37d295765edefb4606
Signed-off-by: Dominig ar Foll Intel Open Source <dominig.arfoll@fridu.net>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-09-16 14:16:55 -07:00

1.7 KiB
Raw Blame History

Navigate StarlingX source code

StarlingX code is kept in multiple Git directories. To simplify the process of keeping your local copy up to date, the StarlingX project provides Android-type repo manifests that can be followed by the Android Repo tool.

Required tools

In addition to your preferred text editor you will need two tools to download the StarlingX source code:

  • Git (available from your preferred Linux distro)
  • Android Repo tool (a simple python script that is installed manually)

To install Git, follow the instructions to install the Git package from your Linux distro.

To install the required Android Repo tool on the Linux host system, follow the steps in the Installing Repo <https://source.android.com/setup/build/downloading#installing-repo>

Additional information about the Repo tool is available in the Repo Command Reference <https://source.android.com/setup/develop/repo>.

Initial download of StarlingX code

  1. Create a starlingx workspace directory on your system. Best practices dictate creating the workspace in your $HOME directory:

    $ mkdir -p $HOME/starlingx/

  2. Use the Repo tool to create a local clone of the manifest Git repository based on the master branch:

    $ cd $MY_REPO_ROOT_DIR
$ repo init -u https://opendev.org/starlingx/manifest -m default.xml

  3. Synchronize the repository:

    $ repo sync -j`nproc`

Keeping in sync with StarlingX upstream

$ repo sync -j`nproc`