Skip to content

Commit 33426fa

Browse files
committed
Document how --releasever, --releasever_{major,minor} affect each other
Upstream commit: e931960
1 parent ad6fb69 commit 33426fa

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

dnf/conf/config.py

+16
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,12 @@ def releasever(self):
425425
@releasever.setter
426426
def releasever(self, val):
427427
# :api
428+
"""
429+
Sets the releasever variable and sets releasever_major and
430+
releasever_minor accordingly. releasever_major is set to the part of
431+
$releasever before the first ".". releasever_minor is set to the part
432+
after the first ".".
433+
"""
428434
if val is None:
429435
self.substitutions.pop('releasever', None)
430436
return
@@ -438,6 +444,11 @@ def releasever_major(self):
438444
@releasever_major.setter
439445
def releasever_major(self, val):
440446
# :api
447+
"""
448+
Override the releasever_major variable, which is usually derived from
449+
the releasever variable. This setter does not update the value of
450+
$releasever.
451+
"""
441452
if val is None:
442453
self.substitutions.pop('releasever_major', None)
443454
return
@@ -446,6 +457,11 @@ def releasever_major(self, val):
446457
@property
447458
def releasever_minor(self):
448459
# :api
460+
"""
461+
Override the releasever_minor variable, which is usually derived from
462+
the releasever variable. This setter does not update the value of
463+
$releasever.
464+
"""
449465
return self.substitutions.get('releasever_minor')
450466

451467
@releasever_minor.setter

doc/command_ref.rst

+2
Original file line numberDiff line numberDiff line change
@@ -337,10 +337,12 @@ Options
337337
``--releasever_major=<major version>``
338338
Override the releasever_major variable, which is usually automatically
339339
detected or taken from the part of ``$releasever`` before the first ``.``.
340+
This option does not affect the ``$releasever`` variable.
340341

341342
``--releasever_minor=<minor version>``
342343
Override the releasever_minor variable, which is usually automatically
343344
detected or taken from the part of ``$releasever`` after the first ``.``.
345+
This option does not affect the ``$releasever`` variable.
344346

345347
.. _repofrompath_options-label:
346348

tests/test_config.py

+3
Original file line numberDiff line numberDiff line change
@@ -149,15 +149,18 @@ def test_ranges(self):
149149
def test_releasever_major_minor(self):
150150
conf = Conf()
151151
conf.releasever = '1.2'
152+
self.assertEqual(conf.releasever, '1.2')
152153
self.assertEqual(conf.releasever_major, '1')
153154
self.assertEqual(conf.releasever_minor, '2')
154155

155156
# override releasever_major
156157
conf.releasever_major = '3'
158+
self.assertEqual(conf.releasever, '1.2')
157159
self.assertEqual(conf.releasever_major, '3')
158160
self.assertEqual(conf.releasever_minor, '2')
159161

160162
# override releasever_minor
161163
conf.releasever_minor = '4'
164+
self.assertEqual(conf.releasever, '1.2')
162165
self.assertEqual(conf.releasever_major, '3')
163166
self.assertEqual(conf.releasever_minor, '4')

0 commit comments

Comments
 (0)