This repository has been archived by the owner on May 17, 2019. It is now read-only.
docs: Add a simpler explanation on how buffers work. #440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch adds an elementary introduction on the mechanism of a buffer plugin, which should be much friendlier to novice users. For now, the introduction covers the following topics: 1. What is a chunk? 2. How a chunk is managed by the plugin? 3. What is "stage" (or "queue")? ...and will be extended further in the subsequent patches.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this patch?
This patch adds an elementary introduction on the mechanism of
a buffer plugin, which should be much friendlier to novice users.
For now, the introduction covers the following topics:
...and will be extended further in the subsequent patches.
Note
This patch is a part of the issue #427.