docs: More labels on commands; add delete; more Makefiles

rocky · Jun 2, 2015 · dd8fc65 · dd8fc65
1 parent 7f04df3
commit dd8fc65
Show file tree

Hide file tree

Showing 21 changed files with 87 additions and 28 deletions.
diff --git a/docs/commands/Makefile b/docs/commands/Makefile
@@ -0,0 +1,9 @@
+# Whatever it is you want to do, it should be handled by the
+# by the main (parent) Makefile. So reissue make from there.
+.PHONY: html
+
+html:
+	$(MAKE) -C .. $@
+
+%: html
+	$(MAKE) -C .. $@
diff --git a/docs/commands/breakpoints.rst b/docs/commands/breakpoints.rst
@@ -8,6 +8,7 @@ Making the program stop at certain points
 
    breakpoints/break
    breakpoints/condition
+   breakpoints/delete
    breakpoints/disable
    breakpoints/enable
    breakpoints/tbreak
diff --git a/docs/commands/breakpoints/Makefile b/docs/commands/breakpoints/Makefile
@@ -0,0 +1,9 @@
+# Whatever it is you want to do, it should be handled by the
+# by the main (parent) Makefile. So reissue make from there.
+.PHONY: html
+
+html:
+	$(MAKE) -C ../.. $@
+
+%: html
+	$(MAKE) -C ../.. $@
diff --git a/docs/commands/breakpoints/break.rst b/docs/commands/breakpoints/break.rst
@@ -1,7 +1,7 @@
 .. _break:
 
-Break
------
+Break (set a breakpoint)
+------------------------
 
 **break** [*location*] [if *condition*]]
 

diff --git a/docs/commands/breakpoints/condition.rst b/docs/commands/breakpoints/condition.rst
@@ -1,7 +1,7 @@
 .. _condition:
 
-Condition
----------
+Condition (add condition to breakpoint)
+---------------------------------------
 
 **condition** *bp_number* *condition*
 

diff --git a/docs/commands/breakpoints/delete.rst b/docs/commands/breakpoints/delete.rst
@@ -1,7 +1,8 @@
 .. _delete:
 
-Delete
-------
+Delete (remove breakpoints)
+---------------------------
+
 **delete** [*bpnumber* [*bpnumber*...]]
 
 Delete some breakpoints.

diff --git a/docs/commands/breakpoints/disable.rst b/docs/commands/breakpoints/disable.rst
@@ -1,7 +1,8 @@
 .. _disable:
 
-Disable
--------
+Disable (disable breakpoints)
+-----------------------------
+
 **disable** *bpnumber* [*bpnumber* ...]
 
 Disables the breakpoints given as a space separated list of breakpoint

diff --git a/docs/commands/breakpoints/enable.rst b/docs/commands/breakpoints/enable.rst
@@ -1,14 +1,16 @@
 .. _enable:
 
-Enable
--------
+Enable (enable breakpoints)
+---------------------------
+
 **enable** *bpnumber* [*bpnumber* ...]
 
 Enables the breakpoints given as a space separated list of breakpoint
 numbers. See also `info break` to get a list.
 
 See also:
 +++++++++
+
 :ref:`disable <disable>`
 
 .. _tbreak:
diff --git a/docs/commands/data/Makefile b/docs/commands/data/Makefile
@@ -0,0 +1,9 @@
+# Whatever it is you want to do, it should be handled by the
+# by the main (parent) Makefile. So reissue make from there.
+.PHONY: html
+
+html:
+	$(MAKE) -C ../.. $@
+
+%: html
+	$(MAKE) -C ../.. $@
diff --git a/docs/commands/data/disassemble.rst b/docs/commands/data/disassemble.rst
@@ -1,7 +1,7 @@
 .. _disassemble:
 
-Disassemble
------------
+Disassemble (CPython disassembly)
+---------------------------------
 
 *disassemble* [*thing*] [*start-line* [*end-line*]]
 

diff --git a/docs/commands/data/eval.rst b/docs/commands/data/eval.rst
@@ -1,7 +1,8 @@
 .. _eval:
 
-Eval
-----
+Eval (evaluate Python code)
+---------------------------
+
 **eval** *python-statement*
 
 Run *python-statement* in the context of the current frame.

diff --git a/docs/commands/data/pp.rst b/docs/commands/data/pp.rst
@@ -1,5 +1,5 @@
-Pp
----
+Pp (pretty print expression)
+----------------------------
 
 **pp** *expression*
 

diff --git a/docs/commands/data/pr.rst b/docs/commands/data/pr.rst
@@ -1,5 +1,5 @@
-Pr
----
+Pr (print expression)
+---------------------
 
 **pr** *expression*
 

diff --git a/docs/commands/data/pydocx.rst b/docs/commands/data/pydocx.rst
@@ -1,5 +1,5 @@
-Pydocx
-------
+Pydocx (show pydoc)
+-------------------
 
 **pydocx** *name* ...
 

diff --git a/docs/commands/running.rst b/docs/commands/running.rst
@@ -8,6 +8,7 @@ Running the program.
 
    running/continue
    running/finish
+   running/jump
    running/next
    running/skip
    running/step
diff --git a/docs/commands/running/Makefile b/docs/commands/running/Makefile
@@ -0,0 +1,9 @@
+# Whatever it is you want to do, it should be handled by the
+# by the main (parent) Makefile. So reissue make from there.
+.PHONY: html
+
+html:
+	$(MAKE) -C ../.. $@
+
+%: html
+	$(MAKE) -C ../.. $@
diff --git a/docs/commands/running/finish.rst b/docs/commands/running/finish.rst
@@ -1,7 +1,7 @@
 .. _finish:
 
-Finish (AKA step out)
---------------------
+Finish (step out)
+-----------------
 
 **finish** [*level*]
 

diff --git a/docs/commands/running/jump.rst b/docs/commands/running/jump.rst
@@ -0,0 +1,16 @@
+.. _jump:
+
+Jump
+----
+
+**jump** *lineno*
+
+Set the next line that will be executed. The line must be within the
+stopped or bottom-most execution frame frame.
+
+See also:
++++++++++
+
+:ref:`step <step>` :ref:`skip <skip>`, :ref:`next <next>`, :ref:`continue
+:ref:<continue>`, and `finish <finish>` provide other ways to progress
+:ref:execution.
diff --git a/docs/commands/running/next.rst b/docs/commands/running/next.rst
@@ -1,9 +1,9 @@
 .. _next:
 
-Next (AKA Step over)
---------------------
+Next (step over)
+----------------
 
-**next**[**+**|**-**] [*count*]
+**next** [ **+** | **-** ] [ *count* ]
 
 Step one statement ignoring steps into function calls at this level.
 

diff --git a/docs/commands/running/step.rst b/docs/commands/running/step.rst
@@ -1,7 +1,7 @@
 .. _step:
 
-Step (AKA step into)
---------------------
+Step (step into)
+----------------
 
 **step**[**+**|**-**|**<**|**>**|**!**] [*event*...] [*count*]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -7,6 +7,6 @@ Welcome to trepan's documentation!
 ==================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    commands