]> git.saurik.com Git - apple/xnu.git/blobdiff - tools/lldbmacros/README.md
xnu-7195.101.1.tar.gz
[apple/xnu.git] / tools / lldbmacros / README.md
index 3446cbd903163c8bd74772c4053f6a5d73fede40..ccff5196fd806ba817f719d3e8e61fe06fcaf7c4 100644 (file)
@@ -170,6 +170,8 @@ Following is a step by step guideline on how to add a new command ( e.g showtask
 
   6. If your function finds issue with the passed argument then you can `raise ArgumentError('error_message')` to notify the user. The framework will automatically catch this and show appropriate help using the function doc string.
 
+  7. Please use "##" for commenting your code. This is important because single "#" based strings may be mistakenly considered in `unifdef` program.
+
  Time for some code example? Try reading the code for function ShowTaskVmeHelper in memory.py.
 
 SPECIAL Note: Very often you will find yourself making changes to a file for some command/summary and would like to test it out in lldb.
@@ -197,7 +199,7 @@ D. Kernel type summaries.
 ==========================
 i. Using summaries
 ------------------
-The lldb debugger provides ways for user to customize how a particular type of object be decsribed when printed. These are very useful in displaying complex and large structures
+The lldb debugger provides ways for user to customize how a particular type of object be described when printed. These are very useful in displaying complex and large structures
 where only certain fields are important based on some flag or value in some field or variable. The way it works is every time lldb wants to print an object it checks
 for registered summaries. We can define python functions and hook it up with lldb as callbacks for type summaries.  For example.