Skip to content

Commit

Permalink
Merge pull request #69 from ECN/documentation-section-parsing
Browse files Browse the repository at this point in the history
Section parsing documentation update
  • Loading branch information
campb303 authored Oct 21, 2020
2 parents c0c2f70 + 6650ec2 commit e6eff7b
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions docs/Section Parsing Formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,3 +336,64 @@ Mike
]
}
```

## Parse Error
An error caused by unexpected formatting. This is not found in the item but generated when the item is parsed.

### Fields
| Key | Value |
| - | - |
|`type`|`parse_error`|
| `datetime` | RFC 8061 formatted datetime string. |
| `file_path` | Full path of the item with the error. |
| `expected` | Description of what the parser was expecting. |
| `got` | Line that cause the parse error. |
| `line_num` | The line number in the item that caused the parse error. |

### Plain Text Example
```
(item aae2 in qsnapshot)
=== Additional information supplied by user ===
Subject: RE: Help with hardware upgrades
From: "Ezra, Kristopher L" <kris@purdue.edu>
Date: Wed, 5 Feb 2020 18:11:58 +0000
If it makes no difference between windows and linux for the fileserver I'd
rather service a linux machine.
Considering the switches, i could do 2 8s and 2 16s. Two of the switches
I'm replacing already service 9 connections and I'd rather not daisy chain.
Is there something driving the price here? I see gigabit switches from
tplink on amazon right now for $50. I dont need managed switches or
anything fancy.
Kris
*** Replied by: emuffley at: 02/05/20 13:22:02 ***
Kris,
Thank you on the server operating question. We will kick that off to our linux folks for discussion.
No daisy chain, agreed. These switches are unmanaged.
For the workstations, are you wanting Windows, Linux or a mix?
Eric Muffley
Systems Engineer, Engineering Computer Network
===============================================
```
### Parsed Example
```jsonc
{
"type": "parse_error",
"datetime": "2020-10-16T10:44:45",
"file_path": "/home/pier/e/benne238/webqueue2/q-snapshot/aae/2",
"expected": "Did not encounter a reply_from_user ending delimiter",
"got": "Kris",
"line_num": 468
}
```

0 comments on commit e6eff7b

Please sign in to comment.