yasm_dbgfmts.7

   1 '\" t
   2 .\"     Title: yasm_dbgfmts
   3 .\"    Author: Peter Johnson <peter@tortall.net>
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: October 2006
   6 .\"    Manual: Yasm Supported Debug Formats
   7 .\"    Source: Yasm
   8 .\"  Language: English
   9 .\"
  10 .TH "YASM_DBGFMTS" "7" "October 2006" "Yasm" "Yasm Supported Debug Formats"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 yasm_dbgfmts \- Yasm Supported Debugging Formats
  23 .SH "SYNOPSIS"
  24 .HP \w'\fByasm\fR\ 'u
  25 \fByasm\fR \fB\-g\ \fR\fB\fIdbgfmt\fR\fR \fB\fI\&.\&.\&.\fR\fR
  26 .SH "DESCRIPTION"
  27 .PP
  28 The standard Yasm distribution includes a number of modules for different debugging formats\&. The debugging information is embedded into the object file\&. Use of a non\-\(lqnull\(rq
  29 debug format also causes Yasm to output all symbols to the object file (including local symbols)\&.
  30 .PP
  31 The debug format is selected on the
  32 \fByasm\fR(1)
  33 command line by use of the
  34 \fB\-g \fR\fB\fIdbgfmt\fR\fR
  35 command line option\&.
  36 .SH "CV8"
  37 .PP
  38 The CV8 debug format is used by Microsoft Visual Studio 2005 (version 8\&.0) and is completely undocumented, although it bears strong similarities to earlier CodeView formats\&. Yasm\'s support for the CV8 debug format is currently limited to generating assembly\-level line number information (to allow some level of source\-level debugging)\&. The CV8 debug information is stored in the \&.debug$S and \&.debug$T sections of the Win64 object file\&.
  39 .SH "DWARF2"
  40 .PP
  41 The DWARF 2 debug format is a complex, well\-documented standard for debugging information\&. It was created to overcome shortcomings in STABS, allowing for much more detailed and compact descriptions of data structures, data variable movement, and complex language structures such as in C++\&. The debugging information is stored in sections (just like normal program sections) in the object file\&. Yasm supports full pass\-through of DWARF2 debugging information (e\&.g\&. from a C++ compiler), and can also generate assembly\-level line number information\&.
  42 .SH "NULL"
  43 .PP
  44 The
  45 \(lqnull\(rq
  46 debug format is a placeholder; it adds no debugging information to the output file\&.
  47 .SH "STABS"
  48 .PP
  49 The STABS debug format is a poorly documented, semi\-standard format for debugging information in COFF and ELF object files\&. The debugging information is stored as part of the object file\'s symbol table and thus is limited in complexity and scope\&. Despite this, STABS is a common debugging format on older Unix and compatible systems, as well as DJGPP\&.
  50 .SH "SEE ALSO"
  51 .PP
  52 \fByasm\fR(1),
  53 \fByasm_objfmts\fR(7)
  54 .SH "AUTHOR"
  55 .PP
  56 \fBPeter Johnson\fR <\&peter@tortall\&.net\&>
  57 .RS 4
  58 Author.
  59 .RE
  60 .SH "COPYRIGHT"
  61 .br
  62 Copyright \(co 2006 Peter Johnson
  63 .br