docs: clarify MeterConfig units - #635
Open
blackdragoon26 wants to merge 1 commit into
Open
blackdragoon26 wants to merge 1 commit into
blackdragoon26 wants to merge 1 commit into
Conversation
Document how MeterSpec.Unit determines the rate and burst-size units used by MeterConfig, and link back to the P4Info definition for easier discovery. Fixes p4lang#301. Signed-off-by: blackdragoon26 <sankalp.jha9643@gmail.com>
Contributor
Author
|
Hihi @jafingerhut, |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR is aiming to clarify that
MeterSpec.Unitdetermines the units used by the rate and burst-size fields inMeterConfig.For
BYTES, rates are expressed in bytes per second and burst sizes in bytes.For
PACKETS, rates are expressed in packets per second and burst sizes in packets.Also add a cross-reference to the
MeterandDirectMetersection whereMeterSpec.Unitis defined.Fixes #301.
Testing
./tools/asciidoclint.py docs/v1/P4Runtime-Spec.adocpython3 tools/test_asciidoclint.py -v