summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2012-05-07 11:42:44 +0200
committerAndreas Schneider <asn@samba.org>2012-05-07 19:20:30 +0200
commitc1c9ab1c79571dfa1ae0a9f92f401ea89a50ca0e (patch)
treeb35ee195620aa4ee9396e39b1b0ca9c152e5a1fc
parent5a758f448d61f327aa510b9b4506a509e346c5df (diff)
downloadsamba-c1c9ab1c79571dfa1ae0a9f92f401ea89a50ca0e.tar.gz
samba-c1c9ab1c79571dfa1ae0a9f92f401ea89a50ca0e.tar.bz2
samba-c1c9ab1c79571dfa1ae0a9f92f401ea89a50ca0e.zip
doc: Fixes for the talloc debugging tutorial.
-rw-r--r--lib/talloc/doc/tutorial_debugging.dox19
1 files changed, 10 insertions, 9 deletions
diff --git a/lib/talloc/doc/tutorial_debugging.dox b/lib/talloc/doc/tutorial_debugging.dox
index 0cc0866370..aadbb0d12c 100644
--- a/lib/talloc/doc/tutorial_debugging.dox
+++ b/lib/talloc/doc/tutorial_debugging.dox
@@ -33,7 +33,8 @@ log function with one of:
- talloc_set_log_fn()
- talloc_set_log_stderr()
-Below given is an sample output of accessing a context after it has been freed:
+The following code is a sample output of accessing a context after it has been
+freed:
@code
talloc_set_log_stderr();
@@ -47,7 +48,7 @@ talloc: access after free error - first free may be at ../src/main.c:55
Bad talloc magic value - access after free
@endcode
-Another example below is an example of the invalid context:
+Another example is an invalid context:
@code
talloc_set_log_stderr();
@@ -61,16 +62,16 @@ Bad talloc magic value - unknown value
@section reports Memory usage reports
-Talloc can print reports of memory usage of specified talloc context to a file
-(or to <code>stdout</code> or <code>stderr</code>). The report can be simple or
-full. The simple report provides information only about the context itself and
-its direct descendants. The full report goes recursively through the entire
-context tree. See:
+Talloc can print reports of memory usage of a specified talloc context to a
+file (to <code>stdout</code> or <code>stderr</code>). The report can be
+simple or full. The simple report provides information only about the context
+itself and its direct descendants. The full report goes recursively through the
+entire context tree. See:
- talloc_report()
- talloc_report_full()
-We will use following code to retrieve the sample report:
+We will use the following code to retrieve the sample report:
@code
struct foo {
@@ -112,4 +113,4 @@ See also:
- talloc_enable_leak_report()
- talloc_enable_leak_report_full()
-*/ \ No newline at end of file
+*/