Module Name: src Committed By: wiz Date: Sun May 27 12:03:02 UTC 2012
Modified Files: src/lib/libexecinfo: backtrace.3 Log Message: Sort sections. Remove dot at end of Nd Sort SEE ALSO. Punctuation fixes. Bump date to import date. Comment out a partial sentence. To generate a diff of this commit: cvs rdiff -u -r1.1 -r1.2 src/lib/libexecinfo/backtrace.3 Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.
Modified files: Index: src/lib/libexecinfo/backtrace.3 diff -u src/lib/libexecinfo/backtrace.3:1.1 src/lib/libexecinfo/backtrace.3:1.2 --- src/lib/libexecinfo/backtrace.3:1.1 Sat May 26 22:02:29 2012 +++ src/lib/libexecinfo/backtrace.3 Sun May 27 12:03:02 2012 @@ -1,4 +1,4 @@ -.\" $NetBSD: backtrace.3,v 1.1 2012/05/26 22:02:29 christos Exp $ +.\" $NetBSD: backtrace.3,v 1.2 2012/05/27 12:03:02 wiz Exp $ .\" .\" Copyright (c) 2012 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -27,12 +27,12 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd January 24, 2012 +.Dd May 26, 2012 .Dt BACKTRACE 3 .Os .Sh NAME .Nm backtrace -.Nd fill in the backtrace of the currently executing thread. +.Nd fill in the backtrace of the currently executing thread .Sh LIBRARY .Lb libexecinfo .Sh SYNOPSIS @@ -61,7 +61,7 @@ is returned. .Pp The .Fn backtrace_symbols_fmt -function, takes an array of previously filled addresses from +function takes an array of previously filled addresses from .Fn backtrace in .Fa addrlist @@ -126,8 +126,17 @@ return a string array on success, and on failure, setting .Va errno . .\" XXX -Diagnostic output may also be produced, by the ELF symbol lookup functions. -function returns a pointer to a string that is the parent directory of +Diagnostic output may also be produced by the ELF symbol lookup functions. +.\" XXX: what's this? +.\" function returns a pointer to a string that is the parent directory of +.Sh SEE ALSO +.Xr dladdr 3 , +.Xr elf 3 +.Sh HISTORY +The +.Fn backtrace +library of functions first appeared in +.Nx 6 . .Sh BUGS .Bl -enum .It @@ -135,10 +144,10 @@ Errors should not be printed but communi .It Because these functions use .Xr elf 3 -this is a separate library instead of be part of libc/libutil so that library -dependencies are not introduced. +this is a separate library instead of being part of libc/libutil +so that no library dependencies are introduced. .It -The linux versions of the functions (there are no _fmt variants), use +The Linux versions of the functions (there are no _fmt variants) use .Ft int instead of .Ft size_t @@ -148,14 +157,6 @@ Since .Xr dladdr 3 only deals with dynamic symbols, we need to find the symbols from the main portion of the program. -For that we need to locate the executable, and we use procfs for to find it -which is not portable. +For that we need to locate the executable, and we use procfs for +finding it, which is not portable. .El -.Sh SEE ALSO -.Xr elf 3 -.Xr dladdr 3 -.Sh HISTORY -The -.Fn backtrace -library of functions first appeared in -.Nx 6 .