Skip to content
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.

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

Fix docs for DS retries #7039

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rob05c
Copy link
Member

@rob05c rob05c commented Aug 25, 2022

Adds and clarifies docs for simple and unavailable retry parameters. Also fixes some related code comments.

Which Traffic Control components are affected by this PR?

  • Documentation

What is the best way to verify this PR?

Generate docs, observe they match code and ATS behavior.

If this is a bugfix, which Traffic Control versions contained the bug?

Not a bug fix.

PR submission checklist

  • [x] This PR has tests no tests, no code change
  • This PR has documentation
  • [x] This PR has a CHANGELOG.md entry no changelog, docs fix is too trivial to clutter the changelog
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY (see the Apache Software Foundation's security guidelines for details)

@rob05c rob05c added documentation related to documentation cache-config Cache config generation labels Aug 25, 2022
@rob05c rob05c force-pushed the add-t3c-simple-retries branch from 4f77f0f to df3d745 Compare August 25, 2022 19:47
@rob05c rob05c force-pushed the add-t3c-simple-retries branch 2 times, most recently from 894e327 to 5ce438f Compare September 19, 2022 19:06
* Allow lock updates on some server params

* Add CHANGELOG and dont update when non-allowed fields are present.

* Sort changelog

* Fix issues

* Code review and add to v5 tests
@rob05c rob05c force-pushed the add-t3c-simple-retries branch from 5ce438f to 87435c0 Compare September 19, 2022 19:08
// are assumed to be present).
// doTail calls t3c-tail and will run a tail on the log file provided with string for a regex to
// match on default is .* endMatch will make t3c-tail exit when a pattern is matched otherwise
// a timeout in a given number of seconds will occur.
Copy link
Contributor

@ocket8888 ocket8888 Sep 21, 2022

Choose a reason for hiding this comment

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

This is removing quite a bit of relevant information, like the fact that this prints to stdout, and also falsely claims some sort of default 'logMatch' value.

Everything after the first paragraph is arguably extraneous, but as-is this edit makes the behavior of doTail misleading at best, IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cache-config Cache config generation documentation related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants