search

xunzhang / gflags

Automatically exported from code.google.com/p/gflags
BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Put public headers in include/ instead of src/ #16

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
In the 1.0-rc1 source archive, the public header files are located in 
src/ rather than in the traditional include/ directory. This is only a 
minor problem, but I think the source tree would be easier to navigate if 
the interface is separated from the implementation at the top level.

Original issue reported on code.google.com by mthuu...@gmail.com on 29 Aug 2008 at 10:57

GoogleCodeExporter commented 9 years ago 
Interesting -- that's not an organization I've seen before, though maybe I'm 
more
typically looking at binaries rather than libraries.  In any case, our setup to
package and distribute packages uses the current structure, which honestly I'm 
not so
bothered by, so I'm going to close this WillNotFix.

Original comment by csilv...@gmail.com on 29 Aug 2008 at 10:08

GoogleCodeExporter commented 9 years ago 
It is very common in libraries. I just checked a few packages and for example 
SDL, 
libxml2, FreeType and the Linux kernel put their public header files in a 
directory 
named "include" in the source tree. Because gflags is a very compact code base, 
the 
only private header file it has is "config.h", but when it grows, please 
reconsider 
separating the public headers.

Original comment by mthuu...@gmail.com on 29 Aug 2008 at 10:34

GoogleCodeExporter commented 9 years ago 
I must be misunderstanding something.  The public headers are separated: 
they're all
in src/gflags (which private headers are elsewhere in src).  I guess you're just
saying they're not separated in a way that it's clear they're public header 
files? 
In any case, I will keep your suggestion in mind.

Original comment by csilv...@gmail.com on 29 Aug 2008 at 10:54

GoogleCodeExporter commented 9 years ago 
Yes, that is exactly what I mean: they are currently nicely separated into a 
subdirectory of "src", but I think it would be clearer if they were:
a) separated at the top level
b) in a directory with a name ("include") that is familiar to a lot of people

Original comment by mthuu...@gmail.com on 29 Aug 2008 at 11:36