Skip to content

Add section on error reporting to coding guidelines #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kinkie wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

Add section on error reporting to coding guidelines #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/DeveloperResources/SquidCodingGuidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,12 @@ components at build time.

* MUST be used inside .h to wrap relevant code.

## Error reporting

To report an error and abort the current transaction, throw a `TextException("descriptive text", Here())`.
Use `Assure(condition)` to test an invariant and abort the current transaction.
To check system-leve invariants, where a failure needs to terminate Squid, use `xassert(condition)`

@yadij yadij Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To check system-leve invariants, where a failure needs to terminate Squid, use `xassert(condition)`
To check system-level invariants, where a failure needs to terminate Squid, use `xassert(condition)`


## See Also

* [DeveloperResources](/DeveloperResources).