Skip to content

Commit 160c909

Browse files
committed
Small change to doxygen docs
1 parent 2e2bf76 commit 160c909

File tree

1 file changed

+0
-37
lines changed

1 file changed

+0
-37
lines changed

include/cpuaff/cpuaff.hpp

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -30,43 +30,6 @@
3030

3131
#pragma once
3232

33-
/*!
34-
* \mainpage
35-
* ### Description
36-
*
37-
* cpuaff is a C++ library that abstracts CPU affinity settings for multiple
38-
* platforms.
39-
*
40-
* ### Details
41-
*
42-
* cpuaff builds up a four part view of every processor on a system. CPUs are
43-
* identified by their socket, core, and processing_unit. Additionally each cpu
44-
* on the system has a notion of its NUMA node. This allows a developer to
45-
* select the CPUs at runtime that achieve the performance goals of his/her
46-
* application.
47-
*
48-
* cpuaff aims to eventually be completely header-only for easy integration into
49-
* existing systems. For the time being the Linux implementation is
50-
* header-only. Other platforms are implemented using
51-
* [hwloc](http://www.open-mpi.org/projects/hwloc/) as an interface to the
52-
* underlying hardware so executables must link to
53-
* [hwloc](http://www.open-mpi.org/projects/hwloc/).
54-
*
55-
* ### Rationale
56-
*
57-
* Managing the CPU affinity of threads within a process is a powerful tool, but
58-
* operating system provided interfaces are often difficult to use and hard to
59-
* understand. To this end, I have created cpuaff which will give an abstract
60-
* view of the CPUs on a given machine and an easy to use interface to get/set
61-
* them within a process.
62-
*
63-
* ### Licensing
64-
*
65-
* cpuaff is distributed under the
66-
* [New BSD](http://opensource.org/licenses/BSD-3-Clause) (or BSD 3-Clause)
67-
*license.
68-
*/
69-
7033
#include "config.hpp"
7134

7235
#include "cpu_spec.hpp"

0 commit comments

Comments
 (0)