Add docs and version bump to 1.0.6

alexbudmsft · Aug 13, 2016 · 679d5e5 · 679d5e5
1 parent b6c265a
commit 679d5e5
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 3 deletions.
diff --git a/docs/Lua/dbgscript.rst b/docs/Lua/dbgscript.rst
@@ -74,7 +74,17 @@ dbgscript Module
    Obtain the size of `type` in bytes. Behaves like ``sizeof`` operator in C.
 
    .. versionadded:: 1.0.4
+
+.. method:: dbgscript.searchMemory(start, size, pattern, pattern_granularity) -> integer
+
+    Search the address space from [start, start + size) for ``pattern``. Only
+    matches at ``pattern_granularity`` are considered. Returns location of match,
+    or throws an error if not found.
+
+    The length of ``pattern`` must be a multiple of ``pattern_granularity``.
 
+   .. versionadded:: 1.0.6
+
 .. method:: dbgscript.startBuffering()
 
    .. include:: ../shared/start_buffering.txt

diff --git a/docs/Python/dbgscript.rst b/docs/Python/dbgscript.rst
@@ -81,7 +81,17 @@ namespace.
    Obtain the size of `type` in bytes. Behaves like ``sizeof`` operator in C.
 
    .. versionadded:: 1.0.4
+
+.. method:: search_memory(start, size, pattern, pattern_granularity) -> int
+
+    Search the address space from [start, start + size) for ``pattern``. Only
+    matches at ``pattern_granularity`` are considered. Returns location of match,
+    or throws LookupError if not found.
+
+    The length of ``pattern`` must be a multiple of ``pattern_granularity``.
 
+   .. versionadded:: 1.0.6
+
 .. method:: start_buffering()
 
    .. include:: ../shared/start_buffering.txt

diff --git a/docs/Ruby/DbgScript.rst b/docs/Ruby/DbgScript.rst
@@ -78,6 +78,16 @@ DbgScript Module
 
    .. versionadded:: 1.0.4
 
+.. method:: DbgScript.search_memory(start, size, pattern, pattern_granularity) -> Integer
+
+    Search the address space from [start, start + size) for ``pattern``. Only
+    matches at ``pattern_granularity`` are considered. Returns location of match,
+    or throws ``KeyError`` if not found.
+
+    The length of ``pattern`` must be a multiple of ``pattern_granularity``.
+
+   .. versionadded:: 1.0.6
+
 .. method:: DbgScript.start_buffering()
 
    .. include:: ../shared/start_buffering.txt

diff --git a/docs/conf.py b/docs/conf.py
@@ -57,9 +57,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0.5'
+version = '1.0.6'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.5'
+release = '1.0.6'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/releasenotes.md b/releasenotes.md
@@ -1,3 +1,9 @@
+1.0.6 (beta)
+------------
+
+* Add `dbgscript.search_memory` API. Searches memory for a pattern and returns
+  location on success.
+
 1.0.5 (beta)
 ------------
 

diff --git a/src/vercommon.h b/src/vercommon.h
@@ -4,7 +4,7 @@
 
 #define DBG_SCRIPT_VER_MAJ 1
 #define DBG_SCRIPT_VER_MIN 0
-#define DBG_SCRIPT_VER_BETA 5
+#define DBG_SCRIPT_VER_BETA 6
 
 #define STR2(x)  #x
 #define STR(x) STR2(x)