starlingx/docs
Code Issues Proposed changes

initial creation Doc page Navigate Git Code story/2005184

Browse Source 
- 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>
This commit is contained in:
Dominig ar Foll Intel Open Source 2019-09-12 10:26:23 +02:00 committed by Kristal Dale
parent 2885714354
commit 783886f365
1 changed files with 56 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
doc/source/developer_resources/navigate_source_code.rst
View File

@ -1,10 +1,60 @@
=========================================
How to navigate the StarlingX source code
=========================================
==============================
Navigate StarlingX source code
==============================
This topic is coming soon.
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.
Linked Story does not yet exist.
--------------
Required tools
--------------
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005184>`__
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
----------------------------------
#. Create a *starlingx* workspace directory on your system.
Best practices dictate creating the workspace in your $HOME directory:
.. code:: sh
$ mkdir -p $HOME/starlingx/
#. Use the Repo tool to create a local clone of the manifest Git repository
based on the `master` branch:
.. code:: sh
$ cd $MY_REPO_ROOT_DIR
$ repo init -u https://opendev.org/starlingx/manifest -m default.xml
#. Synchronize the repository:
.. code:: sh
$ repo sync -j`nproc`
---------------------------------------
Keeping in sync with StarlingX upstream
---------------------------------------
.. code:: sh
$ repo sync -j`nproc`