Skip to content

Commit

Permalink
[hotfix][doc] improve comments in archunit.properties
Browse files Browse the repository at this point in the history
  • Loading branch information
echauchot committed Nov 29, 2023
1 parent b9f3b95 commit 667d3a4
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@
# limitations under the License.
#

# By default we allow removing existing violations, but fail when new violations are added.
# This controls if the violation store is writable
freeze.store.default.allowStoreUpdate=true

# Enable this if a new (frozen) rule has been added in order to create the initial store and record the existing violations.
# Enable this if a new rule was added or the description of an existing rule has changed.
# It is needed to record future violations of this rule.
# If omitted, future violations of the rule will not be considered as violations as the initial store was not created for this rule.
#freeze.store.default.allowStoreCreation=true

# Enable this to add allow new violations to be recorded.
# Enable this to record the current state of violations.
# This can make sense, because current violations are consciously accepted and should be added to the store
# By default we allow removing existing violations, but fail when new violations are added
# NOTE: Adding new violations should be avoided when possible. If the rule was correct to flag a new
# violation, please try to avoid creating the violation. If the violation was created due to a
# shortcoming of the rule, file a JIRA issue so the rule can be improved.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@
# limitations under the License.
#

# By default we allow removing existing violations, but fail when new violations are added.
# This controls if the violation store is writable
freeze.store.default.allowStoreUpdate=true

# Enable this if a new (frozen) rule has been added in order to create the initial store and record the existing violations.
# Enable this if a new rule was added or the description of an existing rule has changed.
# It is needed to record future violations of this rule.
# If omitted, future violations of the rule will not be considered as violations as the initial store was not created for this rule.
#freeze.store.default.allowStoreCreation=true

# Enable this to add allow new violations to be recorded.
# Enable this to record the current state of violations.
# This can make sense, because current violations are consciously accepted and should be added to the store
# By default we allow removing existing violations, but fail when new violations are added
# NOTE: Adding new violations should be avoided when possible. If the rule was correct to flag a new
# violation, please try to avoid creating the violation. If the violation was created due to a
# shortcoming of the rule, file a JIRA issue so the rule can be improved.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@
# limitations under the License.
#

# By default we allow removing existing violations, but fail when new violations are added.
# This controls if the violation store is writable
freeze.store.default.allowStoreUpdate=true

# Enable this if a new (frozen) rule has been added in order to create the initial store and record the existing violations.
# Enable this if a new rule was added or the description of an existing rule has changed.
# It is needed to record future violations of this rule.
# If omitted, future violations of the rule will not be considered as violations as the initial store was not created for this rule.
#freeze.store.default.allowStoreCreation=true

# Enable this to add allow new violations to be recorded.
# Enable this to record the current state of violations.
# This can make sense, because current violations are consciously accepted and should be added to the store
# By default we allow removing existing violations, but fail when new violations are added
# NOTE: Adding new violations should be avoided when possible. If the rule was correct to flag a new
# violation, please try to avoid creating the violation. If the violation was created due to a
# shortcoming of the rule, file a JIRA issue so the rule can be improved.
Expand Down

0 comments on commit 667d3a4

Please sign in to comment.