[prev in list] [next in list] [prev in thread] [next in thread]
List: gnuradio-discuss
Subject: Re: [Discuss-gnuradio] gnuradio component directory structure
From: Tom Rondeau <trondeau1122 () gmail ! com>
Date: 2011-09-26 15:51:52
Message-ID: CANc0s2NVE_HC_YsM=kmfKDBz=tRi1wXF-8ngG8wvCH2vu2o16g () mail ! gmail ! com
[Download RAW message or body]
On Mon, Sep 26, 2011 at 11:48 AM, Ben Hilburn <ben.hilburn@ettus.com> wrote:
> Restarting the discussion for a small point:
>
> > 1) It separates publicly installed headers vs private headers in the lib
> > directory.
>
> I think this, honestly, is the best argument for having the separate
> directory. In terms of project navigation, I think this is really helpful,
> and makes sense.
>
>
> > 2) Its a cleaner separation of API and implementation.
>
> > 3) Its easier to point doxygen to the public headers and keep it from
> > parsing everything in "lib".
>
> This is the point I wanted to comment on. I've worked on a number of
> projects that point Doxygen only to include/, and projects that point to
> both include/ and lib/. Honestly, and while this is obviously highly
> subjective and easily swapped back and forth for anyone that cares, I
> actually prefer including the lib/ directory as well. There is usually a
> whole lot of stuff in the the implementation files that aren't declared in
> the headers, and a lot of it is usually extremely helpful (at least to me)
> when I'm hacking around.
>
> Again, this is obviously preference. If you only want Doxygen to document
> the public GNURadio API, then obviously you only want to point it to
> include. For actually developing _inside_ of GNURadio, however, I often
> find having the lib/ documentation to be very helpful.
>
> Cheers,
> Ben
>
I agree with everything you've said here. I think we'll be including both.
There's some maintenance work on Doxygen that I need to sort out soon, so
making sure we're picking up everything that we want is going to be part of
it.
Thanks,
Tom
> On Mon, Sep 26, 2011 at 5:10 AM, Tom Rondeau <trondeau1122@gmail.com>wrote:
>
>> On Mon, Sep 26, 2011 at 3:39 AM, Martin Braun <martin.braun@kit.edu>wrote:
>>
>>> On Wed, Sep 21, 2011 at 10:04:23AM -0400, Tom Rondeau wrote:
>>> > On Sat, Sep 17, 2011 at 3:14 PM, Martin Braun <martin.braun@kit.edu>
>>> wrote:
>>> >
>>> > I'd like to point out a disadvantage to get a discussion going:
>>> > While you're developing, this might be an inconvenience because the
>>> > files are physically separated. Most IDEs/editors have many
>>> features
>>> > such as tagging, switching from headers to sources and vice versa,
>>> 'go
>>> > to file at cursor' commands etc. If half of the files are somewhere
>>> > else, one has to set up the editor specifically for this dir
>>> structure
>>> > to do all of this.
>>> >
>>> >
>>> > It's a logical separation that a lot of projects use. I know that I'm a
>>> bit
>>> > biased because my "IDE" is Emacs, but I don't recall having project
>>> files in
>>> > different directories was a problem. Way back when I developed in
>>> Windows and
>>> > used Visual Studio, this wasn't an issue, but that could have been due
>>> to the
>>> > project file that VS kept.
>>> >
>>> >
>>> > We haven't made it part of our official standard, but talking with both
>>> > Johnathan and Josh last week about it, I was thinking that we would.
>>> I'm not
>>> > sure that your argument here has quite convinced me that it'll be a
>>> problem.
>>>
>>> To be honest,
>>>
>>> after re-reading this, I'm not even convinced myself.
>>> Sometimes I just like to argue :)
>>>
>>> Martin
>>
>>
>> Always good to have the discussion. I think we're settled on the use of
>> include directory, then.
>>
>> Thanks!
>> Tom
>>
>>
>> _______________________________________________
>> Discuss-gnuradio mailing list
>> Discuss-gnuradio@gnu.org
>> https://lists.gnu.org/mailman/listinfo/discuss-gnuradio
>>
>>
>
[Attachment #3 (text/html)]
<div class="gmail_quote">On Mon, Sep 26, 2011 at 11:48 AM, Ben Hilburn <span \
dir="ltr"><<a href="mailto:ben.hilburn@ettus.com">ben.hilburn@ettus.com</a>></span> \
wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px \
#ccc solid;padding-left:1ex;">
Restarting the discussion for a small point:<div class="im"><div><br></div><div><span \
style="font-family:arial, sans-serif;font-size:12px;background-color:rgb(255, 255, \
255)">> 1) It separates publicly installed headers vs private headers in the \
lib</span></div>
<div><span style="font-family:arial, \
sans-serif;font-size:12px;background-color:rgb(255, 255, 255)">> \
directory.</span></div><div><span style="font-family:arial, \
sans-serif;font-size:12px;background-color:rgb(255, 255, 255)"><br>
</span></div></div><div><span style="font-family:arial, \
sans-serif;font-size:12px;background-color:rgb(255, 255, 255)">I think this, \
honestly, is the best argument for having the separate directory. In terms of \
project navigation, I think this is really helpful, and makes sense.<div class="im">
<br>
<br>> 2) Its a cleaner separation of API and implementation.<br><br></div><div \
class="im">> 3) Its easier to point doxygen to the public headers and keep it \
from<br>> parsing everything in "lib".</div>
</span></div><div><font face="arial, sans-serif"><br>
</font></div><div><font face="arial, sans-serif">This is the point I wanted to \
comment on. I've worked on a number of projects that point Doxygen only to \
include/, and projects that point to both include/ and lib/. Honestly, and while \
this is obviously highly subjective and easily swapped back and forth for anyone that \
cares, I actually prefer including the lib/ directory as well. There is usually a \
whole lot of stuff in the the implementation files that aren't declared in the \
headers, and a lot of it is usually extremely helpful (at least to me) when I'm \
hacking around.</font></div>
<div><font face="arial, sans-serif"><br></font></div><div><font face="arial, \
sans-serif">Again, this is obviously preference. If you only want Doxygen to \
document the public GNURadio API, then obviously you only want to point it to \
include. For actually developing _inside_ of GNURadio, however, I often find having \
the lib/ documentation to be very helpful.</font></div>
<div><font face="arial, sans-serif"><br></font></div><div><font face="arial, \
sans-serif">Cheers,</font></div><div><font face="arial, \
sans-serif">Ben</font></div></blockquote><div><br></div><div>I agree with everything \
you've said here. I think we'll be including both. There's some \
maintenance work on Doxygen that I need to sort out soon, so making sure we're \
picking up everything that we want is going to be part of it.</div>
<div><br></div><div>Thanks,</div><div>Tom</div><div><br></div><div><br></div><div> \
</div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex;"><div><div class="gmail_quote">
<div><div></div><div class="h5">On Mon, Sep 26, 2011 at 5:10 AM, Tom Rondeau <span \
dir="ltr"><<a href="mailto:trondeau1122@gmail.com" \
target="_blank">trondeau1122@gmail.com</a>></span> wrote:<br>
</div></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px \
#ccc solid;padding-left:1ex"><div><div></div><div class="h5"><div \
class="gmail_quote"><div>On Mon, Sep 26, 2011 at 3:39 AM, Martin Braun <span \
dir="ltr"><<a href="mailto:martin.braun@kit.edu" \
target="_blank">martin.braun@kit.edu</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex">
<div>On Wed, Sep 21, 2011 at 10:04:23AM -0400, Tom Rondeau wrote:<br>
> On Sat, Sep 17, 2011 at 3:14 PM, Martin Braun <<a \
href="mailto:martin.braun@kit.edu" target="_blank">martin.braun@kit.edu</a>> \
wrote:<br> ><br>
> I'd like to point out a disadvantage to get a discussion going:<br>
> While you're developing, this might be an inconvenience because the<br>
> files are physically separated. Most IDEs/editors have many features<br>
> such as tagging, switching from headers to sources and vice versa, \
'go<br> > to file at cursor' commands etc. If half of the files are \
somewhere<br> > else, one has to set up the editor specifically for this dir \
structure<br> > to do all of this.<br>
><br>
><br>
> It's a logical separation that a lot of projects use. I know that I'm a \
bit<br> > biased because my "IDE" is Emacs, but I don't recall \
having project files in<br> > different directories was a problem. Way back when I \
developed in Windows and<br> > used Visual Studio, this wasn't an issue, but \
that could have been due to the<br> > project file that VS kept.<br>
><br>
><br>
> We haven't made it part of our official standard, but talking with both<br>
> Johnathan and Josh last week about it, I was thinking that we would. I'm \
not<br> > sure that your argument here has quite convinced me that it'll be a \
problem.<br> <br>
</div>To be honest,<br>
<br>
after re-reading this, I'm not even convinced myself.<br>
Sometimes I just like to argue :)<br>
<br>
Martin</blockquote><div><br></div></div><div>Always good to have the discussion. I \
think we're settled on the use of include directory, \
then.</div><div><br></div><div>Thanks!</div><div>Tom</div><div> </div></div> \
<br></div></div><div class="im">_______________________________________________<br> \
Discuss-gnuradio mailing list<br> <a href="mailto:Discuss-gnuradio@gnu.org" \
target="_blank">Discuss-gnuradio@gnu.org</a><br> <a \
href="https://lists.gnu.org/mailman/listinfo/discuss-gnuradio" \
target="_blank">https://lists.gnu.org/mailman/listinfo/discuss-gnuradio</a><br> \
<br></div></blockquote></div><br></div> </blockquote></div><br>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic