Skip to content

Commit 0ab6448

Browse files
committed
cpuset: Add package comment
Describe use cases (node IDs, HT siblings, etc) Call out novelty (Linux CPU list parse/dump) Describe future work (relax immutable, refactor to use 'set')
1 parent 4477621 commit 0ab6448

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

cpuset.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17+
// Package cpuset represents a collection of CPUs in a 'set' data structure.
18+
//
19+
// It can be used to represent core IDs, hyper thread siblings, CPU nodes, or processor IDs.
20+
//
21+
// The only special thing about this package is that
22+
// methods are provided to convert back and forth from Linux 'list' syntax.
23+
// See http://man7.org/linux/man-pages/man7/cpuset.7.html#FORMATS for details.
24+
//
25+
// Future work can migrate this to use a 'set' library, and relax the dubious 'immutable' property.
1726
package cpuset
1827

1928
import (

0 commit comments

Comments
 (0)