docs: document the unformat '%_' option

Type: docs

Change-Id: Id864fcff768a78aa313b193f2eaabe545d95bec4
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
This commit is contained in:
Paul Vinciguerra
2020-03-05 11:47:41 -05:00
committed by Dave Barach
parent fb8ed8b955
commit 5e0e0df9b4

View File

@ -278,6 +278,20 @@ The phrase "bitzero %|" means "set the specified bit in the supplied
bitmask" if unformat parses "bitzero". Although it looks like it could bitmask" if unformat parses "bitzero". Although it looks like it could
be fairly handy, it's very lightly used in the code base. be fairly handy, it's very lightly used in the code base.
`%_` toggles whether or not to skip input white space.
For transition from skip to no-skip in middle of format string, skip input white space. For example, the following:
```c
fmt = "%_%d.%d%_->%_%d.%d%_"
unformat (input, fmt, &one, &two, &three, &four);
```
matches input "1.2 -> 3.4".
Without this, the space after -> does not get skipped.
```
### How to parse a single input line ### How to parse a single input line
Debug CLI command functions MUST NOT accidentally consume input Debug CLI command functions MUST NOT accidentally consume input