summaryrefslogtreecommitdiffstats
path: root/doc/scripts/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/scripts/README.md')
-rw-r--r--doc/scripts/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/scripts/README.md b/doc/scripts/README.md
new file mode 100644
index 000000000..e3d4c23e8
--- /dev/null
+++ b/doc/scripts/README.md
@@ -0,0 +1,11 @@
+Script Usage
+============
+
+Peering State Model: gen_state_diagram.py
+------------------------------------------
+ $ git clone https://github.com/ceph/ceph.git
+ $ cd ceph
+ $ cat src/osd/PeeringState.h src/osd/PeeringState.cc | doc/scripts/gen_state_diagram.py > doc/dev/peering_graph.generated.dot
+ $ sed -i 's/7,7/1080,1080/' doc/dev/peering_graph.generated.dot
+ $ dot -Tsvg doc/dev/peering_graph.generated.dot > doc/dev/peering_graph.generated.svg
+