Skip to content

What about documentation? #172

Open
Open
@toor1245

Description

@toor1245

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 with GitHub pages or Github Wiki.

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:

  • 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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions