Re: [hwloc-devel] upcoming cleaning of headers and doc sections

[Jeff Squyres (jsquyres)]

Just to throw in a wildcard...

You could also make hwloc.h be pretty minimal, and #include a bunch of others.  
You could divide sub-.h files by:

- types
- section / functionality
- ...?


On Jul 18, 2013, at 8:09 AM, Brice Goglin  wrote:

> 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
> 
> ___
> 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/

Re: [hwloc-devel] upcoming cleaning of headers and doc sections

[Samuel Thibault]

Brice Goglin, le Thu 18 Jul 2013 14:10:28 +0200, a écrit :
> * 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)

I'd say these two.

Samuel