Skip to content

Commit

Permalink
Rename 'Examples' section to 'Usage'
Browse files Browse the repository at this point in the history
They aren't really examples. We should make a new toctree for that and
then bring in code from the dyninst/examples repo.
  • Loading branch information
hainest committed Dec 13, 2022
1 parent 774a725 commit 9a292ec
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
6 changes: 3 additions & 3 deletions docs/dataflowAPI/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ Stack Height
Stack Height represents the difference between a value in an abstract
location and the stack pointer at a function’s call site.

.. _`sec:dataflow-examples`:
.. _`sec:dataflow-usage`:

Examples
========
Usage
=====

We show several examples of how to use DataflowAPI. In these examples,
we assume that the mutatee has been parsed and we have function and
Expand Down
6 changes: 3 additions & 3 deletions docs/parseAPI/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ binary code:
provides a SymtabAPI-based code source that understands ELF, COFF and
PE file formats.

.. _`sec:example`:
.. _`sec:parseapi-usage`:

Examples
========
Usage
=====

Function Disassembly
--------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/patchAPI/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ PatchAPI for 1st party code patching.
Furthermore, Patcher implicitly adds Instrumenter to the end of the
Command list to generate binary code and install the instrumentation.

.. _sec-example:
.. _sec-patchapi-usage:

Examples
========
Usage
=====

To illustrate the ideas of PatchAPI, we present some simple code
examples that demonstrate how the API can be used.
Expand Down
6 changes: 4 additions & 2 deletions docs/symtabAPI/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,10 @@ useful because libraries can load at different addresses in different
processes. Each AddressLookup instance is associated with, and provides
mapping for, one process.

Examples
========
.. _symtabapi-usage:

Usage
=====

To illustrate the ideas in the API, this section presents several short
examples that demonstrate how the API can be used. SymtabAPI has the
Expand Down

0 comments on commit 9a292ec

Please sign in to comment.