TP 1: repo and manifest
=======================

Instructions
------------

* Subject tag: ``TP1``

* **Deadline: 17/06/2018 23h42**

Subject objectives
------------------

* Be able to create a valid repo manifest with many remotes and revisions.
* Be able to use ``repo``: initialization, synchronization and patch uploads.
* Get used to AOSP review process.

Subject
-------

You are going to create a Vim configuration.

.. note::
   From parts 1. to 5., you are allowed to bypass the review system.

At this end of this practical work, your sync directory must look like this:

.. code:: bash

    ├── .vim
    │   ├── autoload
    │   │   └── pathogen.vim
    │   ├── bundle
    │   │   └── hemisu
    │   │       ├── colors
    |   │       │   └── hemisu.vim
    │   │       └── README.md
    │   ├── CONTRIBUTING.markdown
    │   └── README.markdown
    ├── vimrc
    │   └── vimrc
    └── .vimrc


Documentation:

#. `Manifest documentation`_ 

#. `A manifest example`_
 

1. Create a valid manifest for our vim configuration environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Git repository name:
   vimconfig-manifest-<login>

#. Create a basic manifest.

#. Add a ``github`` remote with a default revision set to ``master``.

#. Add `pathogen.vim`_ project with its path sets to ``.vim``.

.. warning::
   You need to have a Github account and an associated SSH key in order to be
   able to use SSH protocol.

.. hint::
   In order to test your modifications, you must commit them first. Create a
   test directory. In this directory, run a ``repo init -u <URL>`` where URL can
   be a local path and then, a ``repo sync``.

   In order to ease your tests without breaking your local vim configuration, you
   can use this `Dockerfile <_static/Dockerfile_vim>`_. 

   .. code:: bash

       docker build -t sand-tp1 .
       docker run -u=`id -u $USER` -v <your sync directory>:/home/gistre \
        -v <some tests>:/home/gistre/tests -t -i sand-tp1

.. admonition:: Question 1

   What does ``repo init`` command generate ? Identity the root elements.

.. admonition:: Question 2

   What does ``repo sync`` command generate ? Identity the new root elements.


2. Add a .vimrc configuration file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Git repository name:
   vimrc-<login>


#. Add a ``vimrc`` file into vimrc repository. Add the following lines:

   * ``execute pathogen#infect('$HOME/.vim/bundle/{}')``

In your manifest:

#. Add a ``sand`` remote without any default revision pointing to Gerrit URL.

#. Add ``vimrc`` project.

.. admonition:: Question 3

   Why does this configuration fail ?

#. Fix the project declaration.

#. From your local sync directory, add the following line to your ``vimrc`` file:

   * ``syntax on``
   
#. Run ``repo status``.

#. Run ``repo diff``.

#. Push your modifications.

#. Using project configuration in the manifest, put the `.vimrc` file at the
   root of your sync directory.


3. Add a vim bundle
^^^^^^^^^^^^^^^^^^^

#. Add `Hemisu`_ project. Add project configurations if needed.

#. Follow Github instructions for the bundle installation. Do not forget to
   update your .vimrc file.

#. Set project group to ``bundle``.

4. Add a default manifest remote
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. admonition:: Question 4

   Which remote remote should be the default one ? Why ?

#. Add a default remote with a default revision, with a synchronization only on
   the revision, using two threads.

5. Add an optional bundle
^^^^^^^^^^^^^^^^^^^^^^^^^

#. Add `vim-gitgutter`_ bundle to your vim configuration environment.

#. Set the project group to ``bundle`` and ``notdefault``.

#. Run ``repo list``.

.. admonition:: Question 5

   What is happening here ?

6. Fill up your vimrc
^^^^^^^^^^^^^^^^^^^^^

Now, you will respect AOSP submission process, so follow the instructions given
in the submissions documentation.

#. Go to ``vimrc`` directory.

#. Your branch **must** be called ``vimrc_update``.

#. Add some configurations in your ``.vimrc`` file.

#. Upload your modifications.

.. admonition:: Question 6

   Explain the errors you are facing.

#. Fix up your manifest and re-try to upload your change.



.. _pathogen.vim: https://github.com/tpope/vim-pathogen
.. _Hemisu: https://github.com/noahfrederick/vim-hemisu
.. _Manifest documentation: https://gerrit.googlesource.com/git-repo/+/master/docs/manifest-format.txt
.. _A manifest example: https://android.googlesource.com/platform/manifest/+/upstream-mirror-lldb/default.xml
.. _vim-gitgutter: https://github.com/airblade/vim-gitgutter