llvm dev - Jul 2016 - Creating llvm/DebugInfo/Msf folder

Hi all,

If you don't care about Debug Info or PDB files you can stop reading now.

Just wanted to give a heads up that I'm planning to add a new folder under
DebugInfo called Msf.

MSF stands for Multi-Stream File and is the container format used by PDB
debug info files.  However, MSF by itself is generic enough that it need
not contain PDB data, and in fact I can think of at least one other case of
MSF files being used to store non-PDB data.

Currently, we have llvm/DebugInfo/PDB which contains both our knowledge of
the PDB format as well as our knowledge of the MSF format.  And worse, some
of this knowledge of MSF files is in DebugInfo/CodeView.  And in some cases
we are saying PDB when we really mean MSF, and in some cases we are saying
MSF when we really mean PDB.

To make the distinction clearer, and to provide a theoretical means by
which someone could use MSF to store non-PDB data, I have a patch to move
all our of MSF knowledge into a separate library.

I'm planning to commit this later today, and mostly just wanted to give a
heads up in case people are surprised when they see a new directory pop up
under DebugInfo.
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160722/6a0e25d1/attachment.html>

While I personally prefer the rolling caps convention for initialisms, all
caps is the more widely used convention across LLVM. In fact,
lib/DebugInfo/PDB is right next to it, so I'd go with that.

Other than that, yeah, sounds good. :)

On Fri, Jul 22, 2016 at 12:07 PM, Zachary Turner via llvm-dev <
llvm-dev at lists.llvm.org> wrote:
> Hi all,
>
> If you don't care about Debug Info or PDB files you can stop reading
now.
>
> Just wanted to give a heads up that I'm planning to add a new folder
under
> DebugInfo called Msf.
>
> MSF stands for Multi-Stream File and is the container format used by PDB
> debug info files.  However, MSF by itself is generic enough that it need
> not contain PDB data, and in fact I can think of at least one other case of
> MSF files being used to store non-PDB data.
>
> Currently, we have llvm/DebugInfo/PDB which contains both our knowledge of
> the PDB format as well as our knowledge of the MSF format.  And worse, some
> of this knowledge of MSF files is in DebugInfo/CodeView.  And in some cases
> we are saying PDB when we really mean MSF, and in some cases we are saying
> MSF when we really mean PDB.
>
> To make the distinction clearer, and to provide a theoretical means by
> which someone could use MSF to store non-PDB data, I have a patch to move
> all our of MSF knowledge into a separate library.
>
> I'm planning to commit this later today, and mostly just wanted to give
a
> heads up in case people are surprised when they see a new directory pop up
> under DebugInfo.
>
> _______________________________________________
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160722/2c2d7c3b/attachment.html>

I actually regret doing all caps for PDB, and there seems to be mixed use
of all caps / rolling caps even with dwarf (some places say DWARF, others
say Dwarf).  I don't feel too strongly aside from the minor inconvenience
of having to change thousands of occurrences where I already used rolling
caps though :-/

On Fri, Jul 22, 2016 at 10:52 AM Reid Kleckner <rnk at google.com> wrote:
> While I personally prefer the rolling caps convention for initialisms, all
> caps is the more widely used convention across LLVM. In fact,
> lib/DebugInfo/PDB is right next to it, so I'd go with that.
>
> Other than that, yeah, sounds good. :)
>
> On Fri, Jul 22, 2016 at 12:07 PM, Zachary Turner via llvm-dev <
> llvm-dev at lists.llvm.org> wrote:
>
>> Hi all,
>>
>> If you don't care about Debug Info or PDB files you can stop
reading now.
>>
>> Just wanted to give a heads up that I'm planning to add a new
folder
>> under DebugInfo called Msf.
>>
>> MSF stands for Multi-Stream File and is the container format used by
PDB
>> debug info files.  However, MSF by itself is generic enough that it
need
>> not contain PDB data, and in fact I can think of at least one other
case of
>> MSF files being used to store non-PDB data.
>>
>> Currently, we have llvm/DebugInfo/PDB which contains both our knowledge
>> of the PDB format as well as our knowledge of the MSF format.  And
worse,
>> some of this knowledge of MSF files is in DebugInfo/CodeView.  And in
some
>> cases we are saying PDB when we really mean MSF, and in some cases we
are
>> saying MSF when we really mean PDB.
>>
>> To make the distinction clearer, and to provide a theoretical means by
>> which someone could use MSF to store non-PDB data, I have a patch to
move
>> all our of MSF knowledge into a separate library.
>>
>> I'm planning to commit this later today, and mostly just wanted to
give a
>> heads up in case people are surprised when they see a new directory pop
up
>> under DebugInfo.
>>
>> _______________________________________________
>> LLVM Developers mailing list
>> llvm-dev at lists.llvm.org
>> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20160722/c5e885a8/attachment.html>