pungi/doc/index.rst

.. Pungi documentation master file, created by
   sphinx-quickstart on Thu Jul  2 08:11:04 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Pungi's documentation!
=================================

Contents:

.. toctree::
    :maxdepth: 2

    about
    phases
    format
    configuration
    examples
    scm_support
    messaging
    gathering
    koji
    comps
    contributing
    testing
Rewrite documentation to Sphinx. 2015-07-02 13:15:27 +00:00			`.. Pungi documentation master file, created by`
			`sphinx-quickstart on Thu Jul 2 08:11:04 2015.`
			`You can adapt this file completely to your liking, but it should at least`
			contain the root `toctree` directive.

			`Welcome to Pungi's documentation!`
			`=================================`

			`Contents:`

			`.. toctree::`
			`:maxdepth: 2`

			`about`
doc: move "Phases" up, "Contributing" down The "Phases" section breaks down what Pungi does in detail. Place it towards the top of the documentation table of contents. The "Contributing" and "Testing" sections are relevant to developers, not all users, so move them to the end. Signed-off-by: Ken Dreyer <kdreyer@redhat.com> 2017-12-08 20:39:29 +00:00			`phases`
docs: Document config file format Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> 2017-06-08 13:41:36 +00:00			`format`
Document configuration options. 2015-07-10 11:47:29 +00:00			`configuration`
doc: Add full examples of compose configuration JIRA: COMPOSE-3797 Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> 2019-10-14 09:02:46 +00:00			`examples`
docs: Add documentation for scm_dict Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> 2017-08-08 12:15:17 +00:00			`scm_support`
Move messaging into cli options The messaging is not really part of compose settings. It is an infrastructure part. As such, it should really be set up as part of pungi invocation, not compose configuration. The documentation is updated to reflect this. Some updates to the documentation are done as well: listing messages about ISOs and minor formatting updates. The test_compose.sh script can now accept additional command line options and pass them on to pungi-koji to simplify testing. Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> 2015-11-26 07:45:33 +00:00			`messaging`
docs: Add a basic info about gathering packages Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> 2017-05-16 13:36:05 +00:00			`gathering`
Add support for not having koji volume mounted locally With this patch, Pungi can be configured with a local directory to be used as a cache for RPMs, and it will download packages from Koji over HTTP instead of reading them from filesystem directly. The files from the cache can then be hardlink as usual. There is locking in place to avoid different composes running at the same time to step on each other. This is now supported for RPMs only, be it real builds or scratch builds. Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> (cherry picked from commit 631bb01d8f9eac2045a8933a89e0941df7b5f9e6) 2022-12-12 08:23:31 +00:00			`koji`
docs: Describe comps processing Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com> 2018-04-05 12:00:06 +00:00			`comps`
doc: move "Phases" up, "Contributing" down The "Phases" section breaks down what Pungi does in detail. Place it towards the top of the documentation table of contents. The "Contributing" and "Testing" sections are relevant to developers, not all users, so move them to the end. Signed-off-by: Ken Dreyer <kdreyer@redhat.com> 2017-12-08 20:39:29 +00:00			`contributing`
			`testing`