Skip to content

Commit e5716f8

Browse files
committed
for #1346... update documentation to make subtopic order dependency explicit
1 parent 1c8cd0a commit e5716f8

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/source/Reference/sr3_options.7.rst

+21
Original file line numberDiff line numberDiff line change
@@ -546,6 +546,9 @@ The broker option tell each component which broker to contact.
546546
Once connected to an AMQP broker, the user needs to bind a queue
547547
to exchanges and topics to determine the notification messages of interest.
548548

549+
This *subtopic* option should appear after the *broker* setting in files
550+
for the setting to apply to a given queue.
551+
549552

550553
bufSize <size> (default: 1MB)
551554
-----------------------------
@@ -742,6 +745,9 @@ The queue will be written to and recovered from disk if the broker is restarted.
742745
Note: only *persistent* messages will remain in a durable queue after a broker restart.
743746
Persistent messages can be published by enabling the **persistent** option (it is enabled by default).
744747

748+
This *subtopic* option should appear after the *durable* setting in files
749+
for the setting to apply to a given queue.
750+
745751
fileEvents <event,event,...>
746752
----------------------------
747753

@@ -781,6 +787,9 @@ are uptodate. If the exchange already exists, this flag can be set to False,
781787
so no attempt to exchange the queue is made, or it´s bindings.
782788
These options are useful on brokers that do not permit users to declare their exchanges.
783789

790+
This *subtopic* option should appear after the *exchangeDeclare* setting in files
791+
for the topic bindings to apply to the given queue.
792+
784793

785794

786795
expire <duration> (default: 5m == five minutes. RECOMMEND OVERRIDING)
@@ -803,6 +812,9 @@ The default is set low because it defines how long resources on the broker will
803812
and in early use (when default was 1 week) brokers would often get overloaded with very
804813
long queues for left-over experiments.
805814

815+
This *subtopic* option should appear after the *expire* setting in files
816+
for the topic bindings to apply to the given queue.
817+
806818

807819
filename <keyword> (default:None)
808820
-----------------------------------
@@ -1531,6 +1543,9 @@ optimal load sharing, the prefetch should be set as low as possible. However, o
15311543
haul links, it is necessary to raise this number, to hide round-trip latency, so a setting
15321544
of 10 or more may be needed.
15331545

1546+
This *subtopic* option should appear after the *prefetch* setting in files
1547+
for the setting to apply to a given queue.
1548+
15341549
queueBind
15351550
---------
15361551

@@ -1540,6 +1555,9 @@ are uptodate. If the queue already exists, These flags can be
15401555
set to False, so no attempt to declare the queue is made, or it´s bindings.
15411556
These options are useful on brokers that do not permit users to declare their queues.
15421557

1558+
This *subtopic* option should appear after the *queueBind* setting in files
1559+
for the setting to apply to a given queue.
1560+
15431561
queueDeclare
15441562
------------
15451563

@@ -1549,6 +1567,9 @@ are uptodate. If the queue already exists, These flags can be
15491567
set to False, so no attempt to declare the queue is made, or it´s bindings.
15501568
These options are useful on brokers that do not permit users to declare their queues.
15511569

1570+
This *subtopic* option should appear after the *queueDeclare* setting in files
1571+
for the setting to apply to a given queue.
1572+
15521573
queueName|queue|queue_name|qn
15531574
-----------------------------
15541575

sarracenia/config/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ def __repr__(self) -> str:
177177
# options that apply to queues, and so must appear before subtopic resolves queues characteristics.
178178
#
179179
queue_options = [ 'auto_delete', 'broker', 'durable', 'exchange', 'exchangeSuffix', 'expire', 'message_ttl', 'prefetch', \
180-
'qos', 'queueBind', 'exchangeDeclare' ]
180+
'qos', 'queueBind', 'queueDeclare' ]
181181

182182
size_options = ['accelThreshold', 'blockSize', 'bufSize', 'byteRateMax', 'fileSizeMax', 'inlineByteMax']
183183

0 commit comments

Comments
 (0)