docs: sync dlt-adaptor-stdin man page with actual CLI options#841
Open
aki1770-del wants to merge 1 commit into
Open
docs: sync dlt-adaptor-stdin man page with actual CLI options#841aki1770-del wants to merge 1 commit into
aki1770-del wants to merge 1 commit into
Conversation
The man page was out of sync with the implementation in src/adaptor/dlt-adaptor-stdin.c: - SYNOPSIS listed -s which does not exist in getopt string - -v level option (verbosity: FATAL/ERROR/WARN/INFO/DEBUG/VERBOSE) was implemented but not documented - EXAMPLES used '-b -s' — the non-existent -s is removed - Minor: 'context ID tp ctid' typo fixed to 'to' - Minor: -b description clarified Fixes COVESA#813
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.
Problem
The
dlt-adaptor-stdin.1.mdman page was out of sync with the implementation insrc/adaptor/dlt-adaptor-stdin.cin several ways (as reported in #813):-soption in SYNOPSISgetoptstring is"a:c:bht:v:", no-s-v levelnot documented-b -s-sis used in the dmesg example-cdescriptionFix
-sfrom SYNOPSIS-v levelto SYNOPSIS and OPTIONS-sfrom EXAMPLES (dmesg pipe example)-coption description-bdescription wordingFixes #813