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

improve documentation of lockfile support

Browse Source 
This patch improves the documentation regarding how lockfiles work, where
kas searches for them and how to create/update them. A dedicated section
about the locking mechanism is added to the userguide. The documentation
of the kas internal logic is improved by making the wordings more precise
(e.g. lockspec vs. lockfile).

Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com>
[Jan: fixed overlong lines]
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Felix Moessbauer
2023-05-03 06:05:57 +02:00
committed by Jan Kiszka
parent a206f05616
commit 88964d63b5
3 changed files with 51 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
kas/includehandler.py
View File

@@ -123,9 +123,10 @@ class IncludeHandler:
The includes are read and merged from the deepest level upwards.
In case ignore_lock is false, kas checks if a file <file>.lock.<ext>
exists next to the first entry in top_files. This file is then appended
to the list of top_files.
In case ``ignore_lock`` is ``false``, kas checks if a file
``<file>.lock.<ext>`` exists next to the first entry in
``top_files``. This filename is then appended to the list of
``top_files``.
"""
def __init__(self, top_files, top_repo_path, use_lock=True):

13
kas/plugins/dump.py
View File

@@ -29,9 +29,12 @@
files. The output of this command can be used to further analyse the build
configuration.
When running with --lock, a lock-file is created which only contains the
exact refspecs of each repository. This file can be used to pin the
When running with ``--lock``, a locking spec is created which only contains
the exact refspecs of each repository. This can be used to pin the
refspecs of floating branches, while still keeping an easy update path.
When combining with ``--inplace``, a lockfile is created next to the
first file on the kas cmdline. For details on the locking support, see
:class:`kas.includehandler.IncludeHandler`.
Please note:
@@ -48,14 +51,16 @@
kas build kas-project-expanded.yml
Example of the locking mechanism (call again to regenerate lockfile):
Example of the locking mechanism (call again to regenerate lockfile).
The lockfile is created as ``kas-project.lock.yml``::
kas dump --lock --inplace --update kas-project.yml
The generated lockfile will automatically be used to pin the revisions:
The generated lockfile will automatically be used to pin the revisions::
kas build kas-project.yml
Note, that the lockfiles should be checked-in into the VCS.
"""
import logging