Skip to content

Commit

Permalink
Merge pull request #246 from jaypipes/docs
Browse files Browse the repository at this point in the history
doc: clean up missing docs from old PRs
  • Loading branch information
jaypipes authored May 11, 2021
2 parents a51228b + e3b1d14 commit bb93fcc
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,8 @@ Each `ghw.Partition` struct contains these fields:
* `ghw.Partition.Disk` is a pointer to the `ghw.Disk` object associated with
the partition. This will be `nil` if the `ghw.Partition` struct was returned
by the `ghw.DiskPartitions()` library function.
* `ghw.Partition.UUID` is a string containing the volume UUID on Linux, the
partition UUID on MacOS and nothing on Windows.

```go
package main
Expand Down Expand Up @@ -807,6 +809,11 @@ The `ghw.PCIDevice` struct has the following fields:
`pcidb.ProgrammingInterface` struct that describes the device subclass'
programming interface. This will always be non-nil.

The `ghw.PCIAddress` (which is an alias for the `ghw.pci.address.Address`
struct) contains the PCI address fields. It has a `ghw.PCIAddress.String()`
method that returns the canonical Domain:Bus:Slot.Function ([D]BSF)
representation of this Address

#### Finding a PCI device by PCI address

In addition to the above information, the `ghw.PCIInfo` struct has the
Expand Down Expand Up @@ -1139,6 +1146,8 @@ The `ghw.BaseboardInfo` struct contains multiple fields:
* `ghw.BaseboardInfo.AssetTag` is a string with the baseboard asset tag
* `ghw.BaseboardInfo.SerialNumber` is a string with the baseboard serial number
* `ghw.BaseboardInfo.Vendor` is a string with the baseboard vendor
* `ghw.BaseboardInfo.Product` is a string with the baseboard name on Linux and
Product on Windows
* `ghw.BaseboardInfo.Version` is a string with the baseboard version

**NOTE**: These fields are often missing for non-server hardware. Don't be
Expand Down

0 comments on commit bb93fcc

Please sign in to comment.