Open MPI logo

Hardware Locality Development Mailing List Archives

  |   Home   |   Support   |   FAQ   |   all Hardware Locality Development mailing list

Subject: [hwloc-devel] upcoming cleaning of headers and doc sections
From: Brice Goglin (Brice.Goglin_at_[hidden])
Date: 2013-07-18 08:09:40


FYI, I recently got a lot of feedback about our function lists and
documentation sections.
    http://www.open-mpi.org/projects/hwloc/doc/v1.7.1/modules.php
Several of these sections have confusing names, so I am going to
reorganize all this.

Non-inline functions were initially considered the main hwloc functions,
they went in hwloc.h. Others were inlines and considered less important,
they went in hwloc/helper.h. That doesn't work anymore because many
inlines should rather be documented just near their non-inline friends.
So I'll move things where they belong to create unique and consistent
sections for each topic.

The problem with moving many inlines into hwloc.h is that it'll make
that main header very long and less readable. Ways to improve that:
* only put the prototypes in hwloc.h and keep the inline code somewhere else
* if some sections are obviously less important, keep these out of
hwloc.h (just like the ones in hwloc/helper.h currently)
* only keep the strict minimum (types?) in hwloc.h ?

Brice