[rtems-tools commit] Update Readme.

Chris Johns chrisj at rtems.org
Sun Aug 24 23:45:34 UTC 2014


Module:    rtems-tools
Branch:    master
Commit:    52fc20058b33fb877e38ca9af898a24ea28069f5
Changeset: http://git.rtems.org/rtems-tools/commit/?id=52fc20058b33fb877e38ca9af898a24ea28069f5

Author:    Dhananjay Balan <mb.dhananjay at gmail.com>
Date:      Fri Aug 23 10:13:07 2013 +0530

Update Readme.

Add wiki pages, usage instructions etc.

---

 tools/gdb/python/README.md |   33 +++++++++++++++++++++++++++++----
 1 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/tools/gdb/python/README.md b/tools/gdb/python/README.md
index 8858a4f..1fbbd3e 100644
--- a/tools/gdb/python/README.md
+++ b/tools/gdb/python/README.md
@@ -1,6 +1,31 @@
-rtems-gdb
-=========
+# RTEMS GDB
 
-GDB extenstions to RTEMS.
+GDB extensions to help accelarting RTEMS debugging.
+
+## Usage
+ - Clone the git repo
+ - Fire up gdb and use source command
+```
+$ sparc-rtems4.11-gdb
+
+GNU gdb (GDB) 7.5.1
+Copyright (C) 2012 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
+and "show warranty" for details.
+This GDB was configured as "--host=x86_64-linux-gnu --target=sparc-rtems4.11".
+For bug reporting instructions, please see:
+<http://www.gnu.org/software/gdb/bugs/>.
+(gdb) source path/to/clone/__init__.py
+RTEMS GDB Support loaded
+(gdb)
+```
+
+## Commands Implemented
+ - `rtems object` : Prints rtems objects by ID
+ - [rtems index subcommands](Subcommands)
+
+## Developer documentation
+We have a document to get started with [pretty printer development](Writing-a-pretty-printer).
 
-See [this blog post for instructions](http://dbalan.github.io/blog/2013/06/23/debugging-rtems-with-gdb/)



More information about the vc mailing list