Skip to content

Commit 6363c94

Browse files
committed
README.rst: add Usage section and minor cleanup
1 parent bcb7422 commit 6363c94

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ python-ethtool
33

44
*Python bindings for the ethtool kernel interface*
55

6-
**This is a new upstream for python-ethtool maintained by Fedora's
6+
**This is the new upstream for python-ethtool maintained by Fedora's
77
Python SIG.**
88

99
About
@@ -12,24 +12,35 @@ About
1212
Allows querying and changing of ethernet card settings, such as speed,
1313
port, autonegotiation, and PCI locations.
1414

15+
Usage
16+
-----
17+
18+
``pethtool`` mimics behavior of the ``ethtool`` utility, but does not
19+
support all options.
20+
21+
e.g., to get driver information on the ``eth0`` interface::
22+
23+
$ pethtool -i eth0
24+
driver: cdc_ether
25+
bus-info: usb-0000:00:14.0-4.1.3
26+
27+
Further usage information may be found in the ``pethtool(8)`` manpage.
28+
1529
Authors
1630
-------
1731

18-
Original authors
19-
~~~~~~~~~~~~~~~~
20-
2132
* Harald Hoyer
2233
* Arnaldo Carvalho de Melo
2334
* David Sommerseth
2435

2536
Current maintainers
26-
~~~~~~~~~~~~~~~~~~~
37+
-------------------
2738

2839
* Lumír Balhar <lbalhar@redhat.com>
2940
* Miro Hrončok <mhroncok@redhat.com>
3041
* Charalampos Stratakis <cstratak@redhat.com>
3142

32-
Contribution
43+
Contributing
3344
------------
3445

3546
Feel free to help us with improving test coverage, porting to Python 3

0 commit comments

Comments
 (0)