From 7ce6f9bda630696ae0ab00b9683cb9a7c6a82097 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Thu, 20 Feb 2020 16:46:40 -0600 Subject: [PATCH] Clarify tarball-base schema use Change-Id: I541c5f78c038733c5d96928ec44a92f903cbb1fb Signed-off-by: Sean McGinnis --- doc/source/reference/using.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/reference/using.rst b/doc/source/reference/using.rst index a5ed18637d..339e1806b9 100644 --- a/doc/source/reference/using.rst +++ b/doc/source/reference/using.rst @@ -342,6 +342,11 @@ The top level of a deliverable file is a mapping with keys: canonicalized output of ``python setup.py --name``, such as if it uses capitalized letters ("DragonFlow" instead of "dragonflow"). + ``tarball-base`` + An optional name for the base of the tarball created by the + release. If no value is provided, it defaults to the repo base name or + an overridden value set on a specific release entry under ``releases``. + ``release-type`` This (optional) key sets the level of validation for the versions numbers. @@ -460,7 +465,8 @@ Each entry in the ``projects`` list is a mapping with keys: ``tarball-base`` An optional name for the base of the tarball created by the - release. If no value is provided, it defaults to the repo base name. + release. If no value is provided, it defaults to the ``repository-settings`` + value if set, else the repo base name. Each entry in the ``branches`` list is a mapping with keys: