Commit Graph

27 Commits

Author SHA1 Message Date
Marcus Schäfer
23c198dc03
Update manual page documentation
Fixed manual pages to use kiwi-ng as the command name
2020-02-25 10:42:02 +01:00
Marcus Schäfer
f6f77b3162
Fixup documentation for consistency
There is the legacy kiwi version and there is this kiwi(next generation).
From a documentation perspective there are several inconsistencies that
could confuse users. This commit makes the name for KIWI-NG consistent
across the entire documentation. At places where we point to older
documentation we use the term Legacy KIWI and a link to the documentation
that covers this part. All this is needed in preparation to cleanup the
documentation situation for the SUSE documentation but with respect to
the upstream doc sources, their layout and markup.
2020-02-19 18:01:14 +01:00
Marcus Schäfer
89226abd46
Addded doc_suse tox target to build docbook target
SUSE documentation is based on docbook or asciidoc. The kiwi
documentation is maintained along with the code and uses the
sphinx system and therefore ReST as markup language. We would
like to keep one source and don't want to move to another markup
language. Thus the sources needs to be structured in a way that
allows translation into sphinx supported targets as well as
into SUSE docbook style. This commit changes the documentation
structure in a way that both is possible. With the use of Sphinx
XML and rstxml2docbook the ReST docs are converted into docbook.
From there the SUSE daps tool can create SUSE documentation
2020-02-14 15:14:30 +01:00
Marcus Schäfer
be17186503
Add --add-bootstrap-packages option
The prepare and build commands now allows to specify additional
packages to be installed as part of the early bootstrap phase
This Fixes #1151
2019-08-29 11:38:56 +02:00
Marcus Schäfer
70bc4fdda1
Update documentation
The kiwi-descriptions repository has been moved into the
OSInside organisation
2019-07-10 15:15:58 +02:00
Marcus Schäfer
1d3b9a077f
Update documentation for consistency
Instead of hard coded names for example images and their
versions a prolog map including placeholders has been
added.
2019-05-27 18:04:47 +02:00
Dan Čermák
472e7faeda
Improve the documentation of the runtime configuration file
Co-Authored-By: Thomas Schraitle <tom_schr@web.de>
2019-05-02 12:25:36 +02:00
Dan Čermák
43d73f53ab
Document the usage of profiles via the CLI and OBS 2019-04-24 22:57:24 +02:00
David Cassany
72a63f0b16
Add custom partitioning docs
This commit adds two new documentation chapters. One covering
custom partitioning scheme in KIWI. And another covering setting
custom volumes in KIWI
2019-02-04 16:38:50 +01:00
David Cassany
1e85503322 Update the man pages 2018-01-24 19:40:50 +01:00
Ryan Desfosses
c3e520d2ab s/42.1/42.3/ 2017-10-25 22:03:12 -04:00
Marcus Schäfer
f7a37fda78 Merge pull request #427 from SUSE/call_comfort_for_compat_mode
More comfort in calling with compat arguments
2017-07-17 10:56:49 +02:00
Marcus Schäfer
06d1a07373 More comfort in calling with compat arguments
In addition to the 'kiwi --compat -- ...' style we also support calling
the kiwi compat mode as a service via 'kiwi compat ...' The preferred
way of calling kiwi with legacy options is via the new compat service.
Thus the documentation also changed to no longer mention the --compat
option but it still exists for compatibility reasons. Fixes #407
2017-07-14 16:18:53 +02:00
Marcus Schäfer
6fe8a2a9d6
Allow use of more fine grain ignore repos options
The meaning of the --ignore-repos option has changed back
to ignore all configured repositories. A new option
named --ignore-repos-used-for-build has been added which
allows to ignore all except imageonly repositories. The
command manual pages has been changed to document the
options. This Fixes #410
2017-07-14 11:55:32 +02:00
Marcus Schäfer
f9f4f0b5e0
Delete obsolete --obs-repo-internal switch 2017-07-07 10:05:28 +02:00
Marcus Schäfer
b51a8e3ded
Create obs project download link like obs does it
In reference to _download_repository_link.html.erb from
https://github.com/openSUSE/open-build-service, we use the
same mechanism to create the download link from an obs://
project definition
2017-07-07 09:18:47 +02:00
Marcus Schäfer
dee0a5af7f Refactor handling of obs repositories
* Delete kiwi internal ibs: and suse: types
* Delete handling for --obs-repo-internal and provide a
  compatibility message to the user
* Buildservice download server url and scope can be configured
  via ~/.config/kiwi/config.yml
* Translate obs urls to http in import_repositories_marked_as_imageinclude
* Use new Uri.is_public method in renamed runtime check
  check_image_include_repos_publicly_resolvable
2017-07-05 16:07:29 +02:00
Marcus Schäfer
62b37ba036 Merge pull request #400 from SUSE/imageinclude_in_add_repo
Allow imageinclude in add|set-repo commandline
2017-06-30 09:52:37 +02:00
Marcus Schäfer
c544dd178b
Allow imageinclude in add|set-repo commandline
The --set-repo and --add-repo commandline options now allows
additionally to specify a true|false value to indicate if the
repository should be part of the system image repository
setup or not. This Fixes #398
2017-06-29 16:44:09 +02:00
Marcus Schäfer
591963bb95
Added creation of zsync control file in bundler
If a --zsync_source url is provided to the bundler call a
zsync control file is created for the compressed parts of
the bundle. This Fixes #364
2017-06-20 18:22:25 +02:00
Marcus Schäfer
22e171165f
Add runtime config man page section
Describe the contents of the KIWI runtime config file
2017-06-18 09:17:00 +02:00
Marcus Schäfer
38ced54ca4 Merge pull request #346 from SUSE/signing_key_option
Add --signing-key option
2017-05-31 16:42:55 +02:00
David Cassany
376e9daa58 Some fine tune updates
* Updated the docs for system_create command
* Reverted dracut image initialization
* Updated yum comment about repo_gpgcheck option
* Updated variable name in disk builder
* Typo correction
2017-05-31 15:41:11 +02:00
David Cassany
26995dbe9c Add --signing-key option
This commit adds --signing-key option which sets a key file to import
into the package manager trusted keys database. This commit adds this
flag support only for zypper.

Fixes #342
2017-05-24 13:11:15 +02:00
Marcus Schäfer
4c4274d1ed
Update manual page of build command
Add information for --allow-existing-root option
2017-05-23 16:35:06 +02:00
Marcus Schäfer
542cf17836
Update manual pages
Add information and use case for --clear-cache option
2017-05-22 17:59:58 +02:00
Marcus Schäfer
2046220c07 Refactor documentation layout and structure
The current design of the documentation does not allow for
continous improvement and development. It's missing a basic
structure and concept for documenting step-by-step workflows
and generic explanations.
2017-05-10 16:32:23 +02:00