Author: sthibaul
Date: 2009-09-09 18:26:27 EDT (Wed, 09 Sep 2009)
New Revision: 914
URL: https://svn.open-mpi.org/trac/hwloc/changeset/914
Log:
regenerate README
Text files modified:
trunk/README | 88 ++++++++++++++++++++--------------------
1 files changed, 44 insertions(+), 44 deletions(-)
Modified: trunk/README
=
=
=
=
=
=
=
=
======================================================================
--- trunk/README (original)
+++ trunk/README 2009-09-09 18:26:27 EDT (Wed, 09 Sep 2009)
@@ -1,16 +1,15 @@
Introduction
-libtopology provides a portable abstraction (across OS, versions,
-architectures, ...) of the hierarchical topology of modern
architectures. It
-primarily aims at helping high-performance computing applications
with
-gathering information about the hardware so as to exploit it
accordingly and
-efficiently.
-
-libtopology provides a hierarchical view of the machine, NUMA
memory nodes,
-sockets, shared caches, cores and simultaneous multithreading. It
also gathers
-various attributes such as cache and memory information.
+hwloc provides a portable abstraction (across OS, versions,
architectures, ...)
+of the hierarchical topology of modern architectures. It primarily
aims at
+helping high-performance computing applications with gathering
information
+about the hardware so as to exploit it accordingly and efficiently.
+
+hwloc provides a hierarchical view of the machine, NUMA memory
nodes, sockets,
+shared caches, cores and simultaneous multithreading. It also
gathers various
+attributes such as cache and memory information.
-libtopology supports the following operating systems:
+hwloc supports the following operating systems:
* Linux (including old kernels not having sysfs topology
information, with
knowledge of cpusets, offline cpus, and Kerrighed support)
@@ -22,33 +21,33 @@
* Windows
* For other OSes, only the number of processors is available for
now.
-For development and debugging purposes, libtopology also offers the
ability to
-work on fake topologies:
+For development and debugging purposes, hwloc also offers the
ability to work
+on fake topologies:
* Symmetrical tree of resources generated from a list of level
arities
* Remote machine simulation through the gathering of Linux sysfs
topology
files
-libtopology may also display the topology in a convenient format,
either in
-graphical mode, or by exporting in PDF, PNG, FIG, ... format, or in
text mode
-(see Examples below).
-
-libtopology offers a programming interface for manipulating
topologies and
-objects. It also brings a powerful cpu bitmap API that is used to
describe
-topology objects location on physical/logical processors. See the
Interface
-example interface below. It may also be used to binding
applications onto
-certain cores or memory nodes. Several utility programs are also
provided to
-ease command-line manipulation of topology objects, binding of
processes, ...
+hwloc may also display the topology in a convenient format, either
in graphical
+mode, or by exporting in PDF, PNG, FIG, ... format, or in text mode
(see
+Examples below).
+
+hwloc offers a programming interface for manipulating topologies
and objects.
+It also brings a powerful cpu bitmap API that is used to describe
topology
+objects location on physical/logical processors. See the Interface
example
+interface below. It may also be used to binding applications onto
certain cores
+or memory nodes. Several utility programs are also provided to ease
+command-line manipulation of topology objects, binding of
processes, ...
Installation
-libtopology (http://libtopology.gforge.inria.fr/) is available
under the BSD
-license. It is hosted by the INRIA Gforge (http://gforge.inria.fr/projects/
-libtopology/). The current SVN snapshot can be fetched with:
-
- * svn checkout svn://scm.gforge.inria.fr/svn/libtopology/trunk
libtopology
- * cd libtopology
- * autoreconf -ifv
+hwloc (http://www.open-mpi.org/projects/hwloc/) is available under
the BSD
+license. It is hosted by Open MPI (http://www.open-mpi.org/). The
current SVN
+snapshot can be fetched with:
+
+ * svn checkout http://svn.open-mpi.org/svn/hwloc/trunk hwloc-trunk
+ * cd hwloc-trunk
+ * ./autogen.sh
Note that autoconf >=2.60, automake >=1.10 and libtool >=2.2.6 are
required in
that case.
@@ -153,12 +152,12 @@
Interface example
-This section shows how to use libtopology with an small example
hwloc-hello.c
-that just prints the topology and binds itself to the first
processor of the
-second core of the machine.
+This section shows how to use hwloc with an small example hwloc-
hello.c that
+just prints the topology and binds itself to the first processor of
the second
+core of the machine.
-Libtopology provides a pkg-config object, so compiling the example
boils down
-to
+Hardware Location provides a pkg-config object, so compiling the
example boils
+down to
CFLAGS+=$(pkg-config --cflags hwloc)
LDLIBS+=$(pkg-config --libs hwloc)
@@ -258,30 +257,31 @@
Further documentation is available in html, manual pages, and pdf
format in the
source tarball in doc/doxygen-doc/ (after doxygen compilation for svn
-checkouts) and are installed in $prefix/share/doc/topology/ and the
usual
-manual repository.
+checkouts) and are installed in $prefix/share/doc/hwloc/ and the
usual manual
+repository.
The basic interface is available in hwloc.h, a lot of traversal
examples are
available as inlines in hwloc/helper.h . On Linux, additional
helpers are
available in hwloc/linux-libnuma.h and on glibc-based systems,
additional
helpers are available in hwloc/glibc-sched.h
-To precisely define the vocabulary used by libtopology, a Glossary
is available
-and should probably be read first.
+To precisely define the vocabulary used by hwloc, a Glossary is
available and
+should probably be read first.
Questions and bugs
-Questions should be sent to the devel mailing list (
-libtopology-de...@lists.gforge.inria.fr, http://lists.gforge.inria.fr/cgi-bin/
-mailman/listinfo/libtopology-devel). Bug reports should be reported
in the
-tracker (http://gforge.inria.fr/tracker/?group_id=1758).
+Questions should be sent to the devel mailing list (http://www.open-mpi.org/
+community/lists/hwloc.php). Bug reports should be reported in the
tracker (
+https://svn.open-mpi.org/trac/hwloc/).
Credits
-libtopology is developed by the INRIA Runtime Team-Project (http://
+TODO: FIXME
+
+hwloc is developed by the INRIA Runtime Team-Project (http://
runtime.bordeaux.inria.fr/) (headed by Raymond Namyst http://dept-info.labri.fr
/~namyst/).
-------------------------------------------------------------------------------
-Generated on Wed Sep 9 17:52:55 2009 for libtopology by doxygen
1.6.1
+Generated on Thu Sep 10 00:25:46 2009 for hwloc by doxygen 1.6.1
_______________________________________________
hwloc-svn mailing list
hwloc-...@open-mpi.org
http://www.open-mpi.org/mailman/listinfo.cgi/hwloc-svn
