Details
Details
- Reviewers
lbrabec jskladan - Commits
- rLTRN7978729e290f: docs: fix mash directive description
none, docs change
Diff Detail
Diff Detail
- Repository
- rLTRN libtaskotron
- Lint
Lint Skipped - Unit
Unit Tests Skipped
Differential D166
Authored by kparal on Jun 27 2014, 9:26 AM.
Revision Contents
Revision Contents
| Path | Packages | |||
|---|---|---|---|---|
| M | libtaskotron/directives/mash_directive.py (11 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| 9ecc33031c0f | 8d7c7f9cc1ae | 63c2ebfc3c70 | Kamil Páral | docs: fix mash directive description (Show More…) | Jun 27 2014, 9:23 AM |
Diff 492
Diff 492
libtaskotron/directives/mash_directive.py
| 1 | # -*- coding: utf-8 -*- | 1 | # -*- coding: utf-8 -*- | ||
|---|---|---|---|---|---|
| 2 | # Copyright 2009-2014, Red Hat, Inc. | 2 | # Copyright 2009-2014, Red Hat, Inc. | ||
| 3 | # License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> | 3 | # License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> | ||
| 4 | # See the LICENSE file for more details on Licensing | 4 | # See the LICENSE file for more details on Licensing | ||
| 5 | from __future__ import absolute_import | 5 | from __future__ import absolute_import | ||
| 6 | 6 | | |||
| 7 | DOCUMENTATION = """ | 7 | DOCUMENTATION = """ | ||
| 8 | module: mash_directive | 8 | module: mash_directive | ||
| 9 | short_description: create a YUM repository from RPM packages using mash | 9 | short_description: create a YUM repository from RPM packages using mash | ||
| 10 | description: | | 10 | description: | | ||
| 11 | Take a directory containing RPM packages and run ``mash`` command on it, | 11 | Take a directory containing RPM packages and run ``mash`` command on it, | ||
| 12 | which creates YUM repository metadata inside of it. | 12 | which creates YUM repository metadata. | ||
| 13 | 13 | | |||
| 14 | This internally calls ``createrepo`` (which can be used separately through the | 14 | This internally calls ``createrepo`` (which can be used separately through the | ||
| 15 | :ref:`createrepo directive <createrepo_directive>`), and then ``mash`` to | 15 | :ref:`createrepo directive <createrepo_directive>`), and then ``mash`` to | ||
| 16 | finish the process. Mash will handle creating delta RPMs (if requested) | 16 | finish the process. Mash will handle creating delta RPMs (if requested) | ||
| 17 | and it will handle creating multilib repository metadata (which is currently | 17 | and it will handle creating multilib repository metadata (which is currently | ||
| 18 | supported just for ``x86_64`` architecture). | 18 | supported just for ``x86_64`` architecture). | ||
| 19 | 19 | | |||
| 20 | .. note:: Beware, when creating multilib repositories, the non-multilib | 20 | .. note:: Beware, when creating multilib repositories, the non-multilib | ||
| 21 | packages (``i386`` packages which shoudn't be part of the ``x86_64`` | 21 | packages (``i386`` packages which shoudn't be part of the ``x86_64`` | ||
| 22 | repository) are deleted from the directory. | 22 | repository) are deleted from the directory. | ||
| 23 | parameters: | 23 | parameters: | ||
| 24 | rpmdir: | 24 | rpmdir: | ||
| 25 | required: true | 25 | required: true | ||
| 26 | description: absolute or relative path to the directory containing RPM files | 26 | description: absolute or relative path to the directory containing RPM files | ||
| 27 | (the task directory is considered the current working directory) | 27 | (the task directory is considered the current working directory) | ||
| 28 | type: str | 28 | type: str | ||
| 29 | arch: | 29 | arch: | ||
| 30 | required: true | 30 | required: true | ||
| 31 | description: list of architectures for which to create YUM metadata | 31 | description: list of architectures for which to create YUM metadata | ||
| 32 | type: list of str | 32 | type: list of str | ||
| 33 | outdir: | ||||
| 34 | required: false | ||||
| 35 | description: absolute or relative path to an output directory, where | ||||
| 36 | repository should be created. If not specified, then ``rpmdir`` is used | ||||
| 37 | as an output directory. | ||||
| 38 | type: str | ||||
| 39 | default: None | ||||
| 33 | dodelta: | 40 | dodelta: | ||
| 34 | required: false | 41 | required: false | ||
| 35 | description: whether to create delta RPMs during the mash process | 42 | description: whether to create delta RPMs during the mash process | ||
| 36 | type: bool | 43 | type: bool | ||
| 37 | default: False | 44 | default: False | ||
| 38 | choices: [True, False] | 45 | choices: [True, False] | ||
| 39 | returns: | | 46 | returns: | | ||
| 40 | ``None`` | 47 | (``string``) path to the directory where the repository has been created | ||
| 41 | raises: | | 48 | raises: | | ||
| 42 | * :class:`.TaskotronDirectiveError`: if ``createrepo`` returns a non-zero exit | 49 | * :class:`.TaskotronDirectiveError`: if ``createrepo`` returns a non-zero exit | ||
| 43 | code | 50 | code | ||
| 44 | version_added: 0.4 | 51 | version_added: 0.4 | ||
| 45 | """ | 52 | """ | ||
| 46 | 53 | | |||
| 47 | EXAMPLES = """ | 54 | EXAMPLES = """ | ||
| 48 | First, download all required RPMs, then create a YUM repository in that | 55 | First, download all required RPMs, then create a YUM repository in that | ||
| ▲ Show 20 Lines • Show All 124 Lines • Show Last 20 Lines | |||||