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