Clarify location of ``{repository_root}``

Fixes #1376
This commit is contained in:
Foo 2015-05-30 15:38:02 +03:00
parent 44d843aaed
commit afab0e577f
4 changed files with 31 additions and 9 deletions

View File

@ -37,6 +37,19 @@ Generic requirements
Until mercurial and bazaar support Python-3 or PyPy powerline will not
support repository information when running in these interpreters.
.. _repository-root:
.. note::
When using ``pip`` ``{repository_root}`` directory referenced in
documentation may be found using ``pip show powerline-status``. In the output
of ``pip show`` there is a line like ``Location: {path}``, that ``{path}`` is
``{repository_root}``. Unless it is ``--editable`` installation this is only
applicable for ``{repository_root}/powerline/…`` paths: something like
``{repository_root}/scripts/powerline-render`` is not present.
When using other packages referenced paths may not exist, in this case refer
to package documentation.
Pip installation
================

View File

@ -25,7 +25,7 @@ If the repository was just cloned the following line needs to be added to the
set rtp+={repository_root}/powerline/bindings/vim
where ``{repository_root}`` is the absolute path to the Powerline installation
directory.
directory (see :ref:`repository root <repository-root>`).
If pathogen is used and Powerline functionality is not needed outside of Vim
then it is possible to simply add Powerline as a bundle and point the path above
@ -82,7 +82,8 @@ Tmux statusline
===============
Add the following lines to :file:`.tmux.conf`, where ``{repository_root}`` is
the absolute path to the Powerline installation directory::
the absolute path to the Powerline installation directory (see :ref:`repository
root <repository-root>`)::
source "{repository_root}/powerline/bindings/tmux/powerline.conf"

View File

@ -16,7 +16,8 @@ Bash prompt
===========
Add the following line to the :file:`bashrc`, where ``{repository_root}`` is the
absolute path to the Powerline installation directory:
absolute path to the Powerline installation directory (see :ref:`repository root
<repository-root>`):
.. code-block:: bash
@ -48,7 +49,8 @@ Zsh prompt
==========
Add the following line to the :file:`zshrc`, where ``{repository_root}`` is the
absolute path to the Powerline installation directory:
absolute path to the Powerline installation directory (see :ref:`repository root
<repository-root>`):
.. code-block:: bash
@ -58,7 +60,8 @@ Fish prompt
===========
Add the following line to :file:`config.fish`, where ``{repository_root}`` is
the absolute path to the Powerline installation directory:
the absolute path to the Powerline installation directory (see :ref:`repository
root <repository-root>`):
.. code-block:: bash
@ -77,9 +80,10 @@ many \*nix distributions. To use it add
. {repository_root}/powerline/bindings/rc/powerline.rc
to :file:`rcrc` file (usually :file:`~/.rcrc`) and make sure ``rc`` is started
as a login shell (with ``-l`` argument): otherwise this configuration file is
not read.
(``{repository_root}`` is the absolute path to the Powerline installation
directory, see :ref:`repository root <repository-root>`) to :file:`rcrc` file
(usually :file:`~/.rcrc`) and make sure ``rc`` is started as a login shell (with
``-l`` argument): otherwise this configuration file is not read.
.. warning::
Original Plan9 shell and its \*nix port are not supported because they are
@ -97,6 +101,9 @@ After launching busybox run the following command:
. {repository_root}/powerline/bindings/shell/powerline.sh
where ``{repository_root}`` is the absolute path to the Powerline installation
directory (see :ref:`repository root <repository-root>`).
Mksh users may put this line into ``~/.mkshrc`` file. Dash users may use the
following in ``~/.profile``:

View File

@ -11,7 +11,8 @@ Awesome widget
background and updates the statusline with ``awesome-client``.
Add the following to :file:`rc.lua`, where ``{repository_root}`` is the absolute
path to Powerline installation directory:
path to Powerline installation directory (see :ref:`repository root
<repository-root>`):
.. code-block:: lua