SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Fix and reformat environment table

Browse Source 
Sphinx complained:

docs/userguide.rst:66: ERROR: Malformed table.
Column span alignment problem in table line 8.

Avoid this by reformatting to a grid table, also adjusting the content a
bit.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Jan Kiszka 2017-07-17 22:38:04 +02:00 committed by Daniel Wagner
parent 72d2eff6bc
commit 5478e43f8a
1 changed files with 41 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
docs/userguide.rst
View File

@ -56,52 +56,47 @@ Command line usage
Environment variables
~~~~~~~~~~~~~~~~~~~~~
============================================= ================================
Environment variable name Description
============================================= ================================
``KAS_WORK_DIR`` The path of the kas work
directory, current work
directory is the default.
``KAS_REPO_REF_DIR`` The path to the repository
reference directory.
Repositories in this directory
are used as references when
cloning. In order for kas to
find those repositories, they
have to be named correctly.
Those names are derived from the
repo url in the kas config.
(E.g. url:
"https://github.com/siemens/meta-iot2000.git"
resolves to the name
"github.com.siemens.meta-iot2000.git")
``KAS_DISTRO`` ``KAS_MACHINE`` ``KAS_TARGET`` This overwrites the respective
setting in the configuration
file.
``SSH_PRIVATE_KEY`` Path to the private key file,
that should be added to an
internal ssh-agent. This key
cannot be password protected.
This setting is useful for
CI building server. On desktop
machines, a ssh-agent running
outside the kas environment is
more useful.
``DL_DIR`` ``SSTATE_DIR`` ``TMPDIR`` Environment variables that are
transfered to the bitbake
environment.
``http_proxy`` ``https_proxy`` ``no_proxy`` This overwrites the proxy
configuration in the
configuration file.
``SSH_AGENT_PID`` SSH agent process id. Used for
cloning over SSH.
``SSH_AUTH_SOCK`` SSH authenication socket. Used
for cloning over SSH.
``SHELL`` The shell to start when using
the `shell` plugin.
``TERM`` The terminal options used in the
`shell` plugin.
============================================= ================================
+-----------------------+-----------------------------------------------------+
| Environment variables | Description |
+=======================+=====================================================+
| ``KAS_WORK_DIR`` | The path of the kas work directory, current work |
| | directory is the default. |
+-----------------------+-----------------------------------------------------+
| ``KAS_REPO_REF_DIR`` | The path to the repository reference directory. |
| | Repositories in this directory are user as |
| | references when cloning. In order for kas to find |
| | those repositories, they have to be named in a |
| | specific way. The repo URLs are translated like |
| | this: "https://github.com/siemens/meta-iot2000.git" |
| | resolves to the name |
| | "github.com.siemens.meta-iot2000.git". |
+-----------------------+-----------------------------------------------------+
| ``KAS_DISTRO`` | This overwrites the respective setting in the |
| ``KAS_MACHINE`` | configuration file. |
| ``KAS_TARGET`` | |
+-----------------------+-----------------------------------------------------+
| ``SSH_PRIVATE_KEY`` | Path to the private key file that should be added |
| | to an internal ssh-agent. This key cannot be |
| | password protected. This setting is useful for CI |
| | build servers. On desktop machines, an ssh-agent |
| | running outside the kas environment is more useful. |
+-----------------------+-----------------------------------------------------+
| ``SSH_AGENT_PID`` | SSH agent process id and authentication socket. |
| ``SSH_AUTH_SOCK`` | Used for cloning over SSH (alternative to |
| | ``SSH_PRIVATE_KEY``). |
+-----------------------+-----------------------------------------------------+
| ``DL_DIR`` | Environment variables that are transferred to the |
| ``SSTATE_DIR`` | bitbake environment. |
| ``TMPDIR`` | |
+-----------------------+-----------------------------------------------------+
| ``http_proxy`` | This overwrites the proxy configuration in the |
| ``https_proxy`` | configuration file. |
| ``no_proxy`` | |
+-----------------------+-----------------------------------------------------+
| ``SHELL`` | The shell to start when using the `shell` plugin. |
+-----------------------+-----------------------------------------------------+
| ``TERM`` | The terminal options used in the `shell` plugin. |
+-----------------------+-----------------------------------------------------+
Use Cases
---------