From 512347ab68692fb2feb52db50f8e9d2fbbc8bb7b Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Tue, 11 Oct 2022 12:35:11 -0400 Subject: [PATCH] doc: use bullets for winbuild "buildrequires" syntax This syntax is complex. Use bullets for each option so it's easier to understand. --- docs/source/winbuild.rst | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/docs/source/winbuild.rst b/docs/source/winbuild.rst index 6a14727a..f7b407f3 100644 --- a/docs/source/winbuild.rst +++ b/docs/source/winbuild.rst @@ -99,22 +99,29 @@ the target's build tag and download files from that build into the VM. Each package listed in ``buildrequires`` can have a colon-delimited list of options associated with it, which determine which files from the build will be -downloaded. By default, all Windows files associated with the dependent build -will be downloaded (this is the same as specifying ``type=win``). In this case, -comma-separated lists of ``platforms=`` and flags can also be specified, in -which case the files downloaded into the VM will be limited to those -associated with one or more of the platform and flag values (more about this -in the ``[files]`` section below. If ``type=rpm`` is specified, then all rpms -associated with the dependent build will be installed. In this case a -comma-separated list of ``arches=`` may be specified, and only rpms matching -one of those arches will be downloaded. If ``type=maven`` is specified, then -comma-separated lists of ``group_ids=``, ``artifact_ids=``, and/or -``versions=`` may be specified, and only Maven artifacts matching at least one -value in each list will be downloaded. In all cases, a ``patterns=`` option -may be specified, which is a comma-separated list of globs to match against -the filenames. Only files matching at least one of the patterns will be downloaded. + * By default, all Windows files associated with the dependent build will be + downloaded (this is the same as specifying ``type=win``). In this case, + comma-separated lists of ``platforms=`` and flags can also be specified, in + which case the files downloaded into the VM will be limited to those + associated with one or more of the platform and flag values (more about + this in the ``[files]`` section below.) + + * If ``type=rpm`` is specified, then all rpms associated with the dependent + build will be downloaded. In this case a comma-separated list of + ``arches=`` may be specified, and only rpms matching one of those arches + will be downloaded. + + * If ``type=maven`` is specified, then comma-separated lists of + ``group_ids=``, ``artifact_ids=``, and/or ``versions=`` may be specified, + and only Maven artifacts matching at least one value in each list will be + downloaded. + + * In all cases, a ``patterns=`` option may be specified, which is a + comma-separated list of globs to match against the filenames. Only files + matching at least one of the patterns will be downloaded. + After downloading the ``buildrequires`` files, Koji places them in a directory based on their type sets variables pointing to their locations. The variable names are based on the dependency name, with some conversions: