Skip to content
New issue

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

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

Already on GitHub? # to your account

doc: take out w + n params, folks get confused. #4874

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

Conversation

janl
Copy link
Member

@janl janl commented Nov 27, 2023

No description provided.

Copy link
Member

@rnewson rnewson left a comment

Choose a reason for hiding this comment

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

there's little utility to setting these, but they -do- work. what's missing from this text is the detail that couchdb will lower the r or w value provided if it knows a required node is down (missing from [node()|nodes()].), which is a distinct failure mode from 'only receive a response once all nodes ... have responded or timed out'.

I've a mild preference for simply correcting this documentation to match the real semantics (as above) rather than striking it.

Alternatively a Pull Request that strikes this text and removes the code that lets you set r and w in chttpd. the documentation then still matches the code.

Copy link
Contributor

@nickva nickva left a comment

Choose a reason for hiding this comment

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

These are valid parameters. Wonder if there is a specific confusing point we can clarify perhaps?

Is this mostly about w=3? We could add a section about the common pitfalls about it , say if we use w=3 but you only two or one nodes up, or describe a scenario with how conflicts can still be generated, and difference between 201 and 202 responses for writes.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants