Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / chromium_org / third_party / yasm / source / patched-yasm / refs/tags/FP2-open-16.06.0 / . / yasm_dbgfmts.7
blob: aed288237f72add8d1a6ad375c865d5f1cefd979 [file] [log] [blame]
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]1'\" t
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]2.\" Title: yasm_dbgfmts
3.\" Author: Peter Johnson <peter@tortall.net>
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]5.\" Date: October 2006
6.\" Manual: Yasm Supported Debug Formats
7.\" Source: Yasm
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]8.\" Language: English
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]9.\"
10.TH "YASM_DBGFMTS" "7" "October 2006" "Yasm" "Yasm Supported Debug Formats"
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]21.SH "NAME"
22yasm_dbgfmts \- Yasm Supported Debugging Formats
23.SH "SYNOPSIS"
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]24.HP \w'\fByasm\fR\ 'u
25\fByasm\fR \fB\-g\ \fR\fB\fIdbgfmt\fR\fR \fB\fI\&.\&.\&.\fR\fR
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]26.SH "DESCRIPTION"
27.PP
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]28The 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
29debug format also causes Yasm to output all symbols to the object file (including local symbols)\&.
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]30.PP
31The debug format is selected on the
32\fByasm\fR(1)
33command line by use of the
34\fB\-g \fR\fB\fIdbgfmt\fR\fR
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]35command line option\&.
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]36.SH "CV8"
37.PP
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]38The 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\&.
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]39.SH "DWARF2"
40.PP
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]41The 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\&.
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]42.SH "NULL"
43.PP
44The
45\(lqnull\(rq
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]46debug format is a placeholder; it adds no debugging information to the output file\&.
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]47.SH "STABS"
48.PP
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]49The 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\&.
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]50.SH "SEE ALSO"
51.PP
52\fByasm\fR(1),
53\fByasm_objfmts\fR(7)
54.SH "AUTHOR"
55.PP
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]56\fBPeter Johnson\fR <\&peter@tortall\&.net\&>
57.RS 4
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]58Author.
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]59.RE
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]60.SH "COPYRIGHT"
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]61.br
ajwong@chromium.org45afe012009-10-23 19:20:20 +0000[diff] [blame]62Copyright \(co 2006 Peter Johnson
hbono@chromium.org8c354912012-11-14 05:27:15 +0000[diff] [blame]63.br