readme: Add CounterType and ProgrammingRestriction

[edwarddavidbaker]

Add documentation to describe event fields CounterType and ProgrammingRestriction.

Pre-merge rendered markdown can be viewed at https://github.com/edwarddavidbaker/perfmon/tree/readme-updates#countertype .

[edwarddavidbaker]

Thanks for drafting readme content Ryan. What do you think about the [N] indexing? Do you think adding a small mermaid diagram would help succinctly show an example?

[rpmclaug]

@edwarddavidbaker Ideally this document could remain legible in text editors; If there's a means to clarify the text description, let's start there.

Can you provide an example of the sort of diagram you think would help?

One possibility to help differentiate these:

flowchart

    MUX(MSRIndex-UMask
    UMask: A,B
    MSRIndex: C,D
    Counter: 0,1) --> MUY{UMask: A
    MSRIndex: C
    Counter: 0,1}
    MUX --> MUZ{UMask: B
    MSRIndex: D
    Counter: 0,1}

    MUCX(MSRIndex-UMask-Counter
    UMask: A,B
    MSRIndex: C,D
    Counter: 0,1) --> MUCY{UMask: A
    MSRIndex: C
    Counter: 0}
    MUCX --> MUCZ{UMask: B
    MSRIndex: D
    Counter: 1}

Loading

[edwarddavidbaker]

@edwarddavidbaker Ideally this document could remain legible in text editors; If there's a means to clarify the text description, let's start there.

Can you provide an example of the sort of diagram you think would help?

One possibility to help differentiate these:

flowchart

    MUX(MSRIndex-UMask
    UMask: A,B
    MSRIndex: C,D
    Counter: 0,1) --> MUY{UMask: A
    MSRIndex: C
    Counter: 0,1}
    MUX --> MUZ{UMask: B
    MSRIndex: D
    Counter: 0,1}

    MUCX(MSRIndex-UMask-Counter
    UMask: A,B
    MSRIndex: C,D
    Counter: 0,1) --> MUCY{UMask: A
    MSRIndex: C
    Counter: 0}
    MUCX --> MUCZ{UMask: B
    MSRIndex: D
    Counter: 1}

Loading

Agreed, the direct text should be comprehensive. Your diagram is similar to what I was thinking to help visualize using JSON content. I also want to include an invalid scenario. Submitting a follow-up commit here soon.