google / google/cpu_features

What about documentation?

Open
#172 5 comments 0 reactions 1 assignee Claimed by @gchatelet View on GitHub
Dominant language
C++
Stars
2.6k
Forks
309
Avg merge
6d 58m
Merged PRs (30d)
2

Description

It seems to me for the usual user, it will be unclear what CPU features have(excluding what was described in README samples).

I would like to propose to introduce documentation that will include the API documentation e.g. [Doxygen](https://www.doxygen.nl/index.html) with GitHub pages or Github Wiki.

```C
typedef struct {
X86Features features;
int family;
int model;
int stepping;
char vendor[13];
} X86Info;
```
Description of structures, what they contain, what each field defined.

Also, it will be great to make it clear what is supported. For example:

_**AMD CPUID supports:**_
- [x] **CPUID Fn0000_0000_E[D,C,B]X Processor Vendor**
- [ ] **CPUID Fn8000_001E_E[D,C,B]X Compute Unit Identifiers**
- [ ] **CPUID Fn8000_001E_EAX Extended APIC ID**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.