remove deprecated fields/functions, clean up docs #348
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ffromani
approved these changes
Jul 20, 2023
|
it seems we need a rebase? other than that good to be merged anytime. |
Mostly documentation cleanups, but this commit does remove a number of deprecated fields and functions: * `ghw.PCIInfo.Classes` (deprecated for >1 year, use pcidb instead) * `ghw.PCIInfo.Products` (deprecated for >1 year, use pcidb instead) * `ghw.PCIInfo.Vendors` (deprecated for >1 year, use pcidb instead) * `ghw.PCIInfo.ListDevices()` (deprecated for >1 year, use `ghw.PCIInfo.Devices`) * `ghw.pkg/pci.Address` (deprecated for >1 year, just use pkg/pci/address package) * `ghw.pkg/pci.AddressFromString()` (deprecated for >1 year, just use pkg/pci/address package) Primary documentation changes were to move the configuration options, environment-setting instructions, serialization and snapshot stuff into an "Advanced Usage" section towards the bottom of the README and focus the main "Usage" part on the domain-specific functions like `CPU()`, `Memory()` etc. Signed-off-by: Jay Pipes <jaypipes@gmail.com>
|
sorry about that @ffromani. Rebased and repushed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly documentation cleanups, but this commit does remove a number of deprecated fields and functions:
ghw.PCIInfo.Classes(deprecated for >1 year, use pcidb instead)ghw.PCIInfo.Products(deprecated for >1 year, use pcidb instead)ghw.PCIInfo.Vendors(deprecated for >1 year, use pcidb instead)ghw.PCIInfo.ListDevices()(deprecated for >1 year, useghw.PCIInfo.Devices)ghw.pkg/pci.Address(deprecated for >1 year, just use pkg/pci/address package)ghw.pkg/pci.AddressFromString()(deprecated for >1 year, just use pkg/pci/address package)Primary documentation changes were to move the configuration options, environment-setting instructions, serialization and snapshot stuff into an "Advanced Usage" section towards the bottom of the README and focus the main "Usage" part on the domain-specific functions like
CPU(),Memory()etc.