Cool; I'll have a look right now. On Apr 20, 2010, at 8:43 AM, Brice Goglin wrote:
> This needs to be backported to the 1.0 branch, but somebody might want > to fix/improve the text, so I am waiting a bit. > > Brice > > > > > bgog...@osl.iu.edu wrote: > > Author: bgoglin > > Date: 2010-04-20 04:06:03 EDT (Tue, 20 Apr 2010) > > New Revision: 1960 > > URL: https://svn.open-mpi.org/trac/hwloc/changeset/1960 > > > > Log: > > Add a documentation section about external helpers > > Text files modified: > > trunk/doc/Makefile.am | 14 +++++---- > > trunk/doc/hwloc.doxy | 57 +++++++++++++++++++++++++++++++++++---- > > 2 files changed, 58 insertions(+), 13 deletions(-) > > > > Modified: trunk/doc/Makefile.am > > ============================================================================== > > --- trunk/doc/Makefile.am (original) > > +++ trunk/doc/Makefile.am 2010-04-20 04:06:03 EDT (Tue, 20 Apr 2010) > > @@ -134,12 +134,14 @@ > > -@mv -f $(DOX_DIR)/latex/tools.tex $(DOX_DIR)/latex/a00002.tex > > -@mv -f $(DOX_DIR)/html/envvar.html $(DOX_DIR)/html/a00003.html > > -@mv -f $(DOX_DIR)/latex/envvar.tex $(DOX_DIR)/latex/a00003.tex > > - -@mv -f $(DOX_DIR)/html/threadsafety.html $(DOX_DIR)/html/a00004.html > > - -@mv -f $(DOX_DIR)/latex/threadsafety.tex $(DOX_DIR)/latex/a00004.tex > > - -@mv -f $(DOX_DIR)/html/embed.html $(DOX_DIR)/html/a00005.html > > - -@mv -f $(DOX_DIR)/latex/embed.tex $(DOX_DIR)/latex/a00005.tex > > - -@mv -f $(DOX_DIR)/html/switchfromplpa.html > > $(DOX_DIR)/html/a00006.html > > - -@mv -f $(DOX_DIR)/latex/switchfromplpa.tex > > $(DOX_DIR)/latex/a00006.tex > > + -@mv -f $(DOX_DIR)/html/interoperability.html > > $(DOX_DIR)/html/a00004.html > > + -@mv -f $(DOX_DIR)/latex/interoperability.tex > > $(DOX_DIR)/latex/a00004.tex > > + -@mv -f $(DOX_DIR)/html/threadsafety.html $(DOX_DIR)/html/a00005.html > > + -@mv -f $(DOX_DIR)/latex/threadsafety.tex $(DOX_DIR)/latex/a00005.tex > > + -@mv -f $(DOX_DIR)/html/embed.html $(DOX_DIR)/html/a00006.html > > + -@mv -f $(DOX_DIR)/latex/embed.tex $(DOX_DIR)/latex/a00006.tex > > + -@mv -f $(DOX_DIR)/html/switchfromplpa.html > > $(DOX_DIR)/html/a00007.html > > + -@mv -f $(DOX_DIR)/latex/switchfromplpa.tex > > $(DOX_DIR)/latex/a00007.tex > > endif > > endif > > > > > > Modified: trunk/doc/hwloc.doxy > > ============================================================================== > > --- trunk/doc/hwloc.doxy (original) > > +++ trunk/doc/hwloc.doxy 2010-04-20 04:06:03 EDT (Tue, 20 Apr 2010) > > @@ -235,13 +235,8 @@ > > hwloc/cpuset.h. > > > > Moreover, hwloc also comes with additional helpers for > > -interoperability with several commonly used environments. For Linux, > > -some specific helpers are available in hwloc/linux.h, and > > -hwloc/linux-libnuma.h if using libnuma. On glibc-based systems, > > -additional helpers are available in hwloc/glibc-sched.h. For Linux > > -systems with the OpenFabrics verbs library, some dedicated helpers are > > -provided in hwloc/openfabrics-verbs.h (this helper file is not yet > > -useful on non-Linux systems with the OpenFabrics verbs library). > > +interoperability with several commonly used environments. > > +See the \ref interoperability section for details. > > > > To precisely define the vocabulary used by hwloc, a \ref termsanddefs > > section is available and should probably be read first. > > @@ -532,6 +527,54 @@ > > > > > > > > +\page interoperability Interoperability with other software > > + > > +hwloc offers its own portable interface but it still may have to > > +interoperate with specific or non-portable libraries that manipulate > > +some similar objects. > > +It thus offers several specific helpers to help converting between > > +those specific interfaces and hwloc. > > + > > +Such external libraries may be specific to some OS or may not always > > +be installed, so hwloc does not explicitly depend on them. > > +However, when a custom program depends on such a library, it may optionally > > +include the corresponding hwloc helper to extend the hwloc interface with > > +dedicated helpers. > > + > > +<dl> > > + > > +<dt>Linux specific features</dt> > > + <dd> > > + hwloc/linux.h offers Linux specific helpers that access some non-portable > > + features of the Linux system, such as binding threads through their tid > > + or parsing kernel CPU mask files. > > + </dd> > > + > > +<dt>Linux libnuma</dt> > > + <dd> > > + hwloc/linux-libnuma.h provides conversion helpers between hwloc CPU sets > > + and libnuma specific types such as nodemasks and bitmasks. > > + It helps you use libnuma memory binding functions with hwloc CPU sets. > > + </dd> > > + > > +<dt>Glibc</dt> > > + <dd> > > + hwloc/glibc-sched.h offers conversion routines between Glibc and hwloc > > + CPU sets so as to manipulate functions such as sched_setaffinity() > > + together with hwloc. > > + </dd> > > + > > +<dt>OpenFabrics Verbs</dt> > > + <dd> > > + hwloc/openfabrics-verbs.h help interoperability with the OpenFabrics > > Verbs > > + interface, for instance by returning the list of processors near an > > + InfiniBand device. > > + </dd> > > + > > +</dl> > > + > > + > > + > > \page threadsafety Thread safety > > > > Like most libraries that mainly fill data structures, hwloc is not > > _______________________________________________ > > hwloc-svn mailing list > > hwloc-...@open-mpi.org > > http://www.open-mpi.org/mailman/listinfo.cgi/hwloc-svn > > > > _______________________________________________ > hwloc-devel mailing list > hwloc-de...@open-mpi.org > http://www.open-mpi.org/mailman/listinfo.cgi/hwloc-devel > -- Jeff Squyres jsquy...@cisco.com For corporate legal information go to: http://www.cisco.com/web/about/doing_business/legal/cri/
