Skip to content

Commit d94e312

Browse files
mulle-natmulle-nat
authored
Update DEBUGGING.md
1 parent ef48d48 commit d94e312

File tree

1 file changed

+41
-37
lines changed

1 file changed

+41
-37
lines changed

Diff for: ‎dox/DEBUGGING.md

+41-37
Original file line numberDiff line numberDiff line change
@@ -9,60 +9,64 @@ Use the following environment variables to let the runtime warn you about
99
inconsistencies. You can set the environment variables to "YES" or "NO".
1010

1111

12-
Variable | Function
13-
------------------------------------- | --------------------------------
14-
`MULLE_OBJC_WARN_ENABLED` | Enables all the following warnings.
15-
  |  
16-
`MULLE_OBJC_WARN_METHOD_TYPE` | Warn if methods with identical names have different types. Example: `- (BOOL) load` and `+ (void) load`.
17-
`MULLE_OBJC_WARN_PEDANTIC_METHODID_TYPE` | This is faster and complains more as it is just string comparing the signatures.
18-
`MULLE_OBJC_WARN_PROTOCOLCLASS` | Warn if a class does not fit the requirements to be a protocol class, but a protocol of the same name exists.
19-
`MULLE_OBJC_WARN_STUCK_LOADABLE` | Warn if classes or categories could not be integrated into the runtime class system. This indicates a missing class or category. The warning appears, when the runtime is released (end of the program). This is enabled by default currently.
12+
| Variable | Function
13+
|----------------------------------------|--------------------------------
14+
| `MULLE_OBJC_WARN_ENABLED` | Enables all the following warnings.
15+
|   |  
16+
| `MULLE_OBJC_WARN_METHOD_TYPE` | Warn if methods with identical names have different types. Example: `- (BOOL) | load` and `+ (void) load`.
17+
| `MULLE_OBJC_WARN_PEDANTIC_METHODID_TYPE` | This is faster and complains more as it is just string comparing the | signatures.
18+
| `MULLE_OBJC_WARN_PROTOCOLCLASS` | Warn if a class does not fit the requirements to be a protocol class, but a | protocol of the same name exists.
19+
| `MULLE_OBJC_WARN_STUCK_LOADABLE` | Warn if classes or categories could not be integrated into the runtime class | system. This indicates a missing class or category. The warning appears, when the runtime is released (end of the | program). This is enabled by default currently.
20+
| `MULLE_OBJC_WARN_CRASH` | If set to `YES` a warning will force an `abort`
21+
| `MULLE_OBJC_WARN_HANG` | If set to `YES` a warning will force a `mulle_objc_hang` | (`MULLE_OBJC_WARN_CRASH` had precedence though)
2022

2123
## Traces
2224

2325
Use the following environment variables to trace runtime operations. You can
2426
set the environment variables to "YES" or "NO".
2527

2628

27-
Variable | Function
28-
----------------------------------------|--------------------------------
29-
`MULLE_OBJC_TRACE_CLASS_CACHE` | Trace as the class cache is created and enlarged.
30-
`MULLE_OBJC_TRACE_METHOD_CACHE` | Trace method caches as they are created and enlarged.
31-
`MULLE_OBJC_TRACE_METHOD_SEARCH` | Trace the search for a methods implementation. This is a good way to learn about the way Objective-C does inheritance.
32-
`MULLE_OBJC_TRACE_METHOD_CALL` | Trace the calling of Objective-C methods, creates lots of output.
33-
  |  
34-
`MULLE_OBJC_TRACE_ENABLED` | Enables all the following traces.
35-
  |  
36-
`MULLE_OBJC_TRACE_CATEGORY_ADD` | Trace whenever a category is added to the runtime system.
37-
`MULLE_OBJC_TRACE_CLASS_ADD` | Trace whenever a class is added to the runtime system.
38-
`MULLE_OBJC_TRACE_CLASS_FREE` | Trace whenever a class is freed.
39-
`MULLE_OBJC_TRACE_DEPENDENCY` | Trace whenever a class or category is queued up to be added to the runtime system, when it's dependencies have not appeared yet.
40-
`MULLE_OBJC_TRACE_DUMP_RUNTIME` | Periodically dump the runtime to tmp during loading.
41-
`MULLE_OBJC_TRACE_FASTCLASS_ADD` | Trace whenever a "fast" class is added to the runtime system.
42-
`MULLE_OBJC_TRACE_INITIALIZE` | Trace calls or non-calls of `+initialize` and +load
43-
`MULLE_OBJC_TRACE_LOADINFO` | Trace the enqueing of loadinfos
44-
`MULLE_OBJC_TRACE_PROTOCOL_ADD` | Trace whenever a protocol is added to the runtime system.
45-
`MULLE_OBJC_TRACE_STATE_BIT` | Trace whenever a class state changes.
46-
`MULLE_OBJC_TRACE_STRING_ADDS` | Trace whenever a constant string is added to the runtime system.
47-
`MULLE_OBJC_TRACE_TAGGED_POINTER` | Trace whenever a class registers for tagged pointers (isa).
48-
`MULLE_OBJC_TRACE_UNIVERSE` | Trace construction and destruction of universes
29+
| Variable | Function
30+
|----------------------------------------|--------------------------------
31+
| `MULLE_OBJC_TRACE_CLASS_CACHE` | Trace as the class cache is created and enlarged.
32+
| `MULLE_OBJC_TRACE_METHOD_CACHE` | Trace method caches as they are created and enlarged.
33+
| `MULLE_OBJC_TRACE_METHOD_SEARCH` | Trace the search for a methods implementation. This is a good way to learn | about the way Objective-C does inheritance.
34+
| `MULLE_OBJC_TRACE_METHOD_CALL` | Trace the calling of Objective-C methods, creates lots of output.
35+
|   |  
36+
| `MULLE_OBJC_TRACE_ENABLED` | Enables all the following traces.
37+
|   |  
38+
| `MULLE_OBJC_TRACE_CATEGORY_ADD` | Trace whenever a category is added to the runtime system.
39+
| `MULLE_OBJC_TRACE_CLASS_ADD` | Trace whenever a class is added to the runtime system.
40+
| `MULLE_OBJC_TRACE_CLASS_FREE` | Trace whenever a class is freed.
41+
| `MULLE_OBJC_TRACE_DEPENDENCY` | Trace whenever a class or category is queued up to be added to the runtime | system, when it's dependencies have not appeared yet.
42+
| `MULLE_OBJC_TRACE_DUMP_RUNTIME` | Periodically dump the runtime to tmp during loading.
43+
| `MULLE_OBJC_TRACE_FASTCLASS_ADD` | Trace whenever a "fast" class is added to the runtime system.
44+
| `MULLE_OBJC_TRACE_HASHSTRINGS` | Trace addition of hash strings
45+
| `MULLE_OBJC_TRACE_INSTANCE` | Trace instance allocation and deallocation
46+
| `MULLE_OBJC_TRACE_INITIALIZE` | Trace calls or non-calls of `+initialize` and +load
47+
| `MULLE_OBJC_TRACE_LOADINFO` | Trace the enqueing of loadinfos
48+
| `MULLE_OBJC_TRACE_PROTOCOL_ADD` | Trace whenever a protocol is added to the runtime system.
49+
| `MULLE_OBJC_TRACE_STATE_BIT` | Trace whenever a class state changes.
50+
| `MULLE_OBJC_TRACE_STRING_ADDS` | Trace whenever a constant string is added to the runtime system.
51+
| `MULLE_OBJC_TRACE_TAGGED_POINTER` | Trace whenever a class registers for tagged pointers (isa).
52+
| `MULLE_OBJC_TRACE_UNIVERSE` | Trace construction and destruction of universes
4953

5054
## Settings
5155

52-
Variable | Function
53-
----------------------------------------|--------------------------------
54-
`MULLE_OBJC_PEDANTIC_EXIT` | Force destruction of the universe at the end of the program run.
56+
| Variable | Function
57+
|----------------------------------------|--------------------------------
58+
| `MULLE_OBJC_PEDANTIC_EXIT` | Force destruction of the universe at the end of the program run.
5559

5660

5761
## Prints
5862

5963
Like a lesser variation of traces, either prints just once or modified a trace.
6064

6165

62-
Variable | Function
63-
----------------------------------------|--------------------------------
64-
`MULLE_OBJC_PRINT_UNIVERSE_CONFIG` | Print the version of the universe, maybe more in the future.
65-
`MULLE_OBJC_PRINT_ORIGIN` | Print the owner of methodlists in loadinfo traces. This is enabled by default currently.
66+
| Variable | Function
67+
|----------------------------------------|--------------------------------
68+
| `MULLE_OBJC_PRINT_UNIVERSE_CONFIG` | Print the version of the universe, maybe more in the future.
69+
| `MULLE_OBJC_PRINT_ORIGIN` | Print the owner of methodlists in loadinfo traces. This is enabled by default currently.
6670

6771

6872
## Dumps

0 commit comments

Comments
 (0)