[DynInst_API:] [dyninst/dyninst] e75cac: start of work to refactor the docs to use readthedocs

[Tim Haines <noreply@xxxxxxxxxx>]

  Branch: refs/heads/thaines/documentation_modernization
  Home:   https://github.com/dyninst/dyninst
  Commit: e75cac6d06ba31db56396152c26b6c0db0989daf
      https://github.com/dyninst/dyninst/commit/e75cac6d06ba31db56396152c26b6c0db0989daf
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M .gitignore
    R common/doc/manual_commands.tex
    R dataflowAPI/doc/AST.tex
    R dataflowAPI/doc/AbsLocs.tex
    R dataflowAPI/doc/Abstractions.tex
    R dataflowAPI/doc/Assignment.tex
    R dataflowAPI/doc/Examples.tex
    R dataflowAPI/doc/Graph.tex
    R dataflowAPI/doc/Intro.tex
    R dataflowAPI/doc/README
    R dataflowAPI/doc/Slicing.tex
    R dataflowAPI/doc/StackAnalysis.tex
    R dataflowAPI/doc/SymEval.tex
    R dataflowAPI/doc/dataflowAPI.tex
    R dataflowAPI/doc/paradyn_logo.pdf
    A docs/Makefile
    A docs/README.md
    A docs/_static/example/badge/index.html
    A docs/_static/example/badge/treemap/index.html
    A docs/_static/sphinx-argparse.css
    A docs/_static/theme.css
    A docs/assets/dyninst-dragon-small.png
    A docs/assets/dyninst-dragon.png
    A docs/assets/favicon.ico
    A docs/conf.py
    A docs/dataflowAPI/index.rst
    A docs/dynC_API/index.rst
    A docs/generate.sh
    A docs/index.rst
    A docs/instructionAPI/index.rst
    A docs/parseAPI/index.rst
    A docs/patchAPI/index.rst
    A docs/requirements.txt
    A docs/stackwalk/index.rst
    A docs/symtabAPI/index.rst
    R dynC_API/doc/1-DynC.tex
    R dynC_API/doc/2-Language.tex
    R dynC_API/doc/A-TheDyninstDomain.tex
    R dynC_API/doc/dynC_API.tex
    R dynC_API/doc/paradyn_logo.pdf
    R instructionAPI/doc/1-Intro.tex
    R instructionAPI/doc/2-Abstractions.tex
    R instructionAPI/doc/3-API.tex
    R instructionAPI/doc/API/BinaryFunction.tex
    R instructionAPI/doc/API/Dereference.tex
    R instructionAPI/doc/API/Expression.tex
    R instructionAPI/doc/API/Immediate.tex
    R instructionAPI/doc/API/Instruction.tex
    R instructionAPI/doc/API/InstructionAST.tex
    R instructionAPI/doc/API/InstructionDecoder.tex
    R instructionAPI/doc/API/InstructionDecoder_x86.tex
    R instructionAPI/doc/API/Operand.tex
    R instructionAPI/doc/API/Operation.tex
    R instructionAPI/doc/API/RegisterAST.tex
    R instructionAPI/doc/API/Result.tex
    R instructionAPI/doc/API/Visitor.tex
    R instructionAPI/doc/examples/Visitor-noop.C
    R instructionAPI/doc/examples/Visitor-regexample.C
    R instructionAPI/doc/fig/ast_ownership.eps
    R instructionAPI/doc/fig/ast_ownership.pdf
    R instructionAPI/doc/fig/decoder_use.eps
    R instructionAPI/doc/fig/decoder_use.pdf
    R instructionAPI/doc/fig/deref-eval.eps
    R instructionAPI/doc/fig/deref-eval.pdf
    R instructionAPI/doc/fig/full_inheritance_graph.eps
    R instructionAPI/doc/fig/full_inheritance_graph.pdf
    R instructionAPI/doc/fig/instruction_representation.eps
    R instructionAPI/doc/fig/instruction_representation.pdf
    R instructionAPI/doc/fig/ownership_graph.eps
    R instructionAPI/doc/fig/ownership_graph.pdf
    R instructionAPI/doc/fig/refman.pdf
    R instructionAPI/doc/instructionAPI.tex
    R instructionAPI/doc/paradyn_logo.pdf
    R parseAPI/doc/.gitignore
    R parseAPI/doc/1-Intro.tex
    R parseAPI/doc/2-Abstractions.tex
    R parseAPI/doc/3-Example.tex
    R parseAPI/doc/4-ParseAPI.tex
    R parseAPI/doc/5-Extending.tex
    R parseAPI/doc/6-Defensive.tex
    R parseAPI/doc/API/Block.tex
    R parseAPI/doc/API/CodeObject.tex
    R parseAPI/doc/API/CodeRegion.tex
    R parseAPI/doc/API/CodeSource.tex
    R parseAPI/doc/API/Containers.tex
    R parseAPI/doc/API/Edge.tex
    R parseAPI/doc/API/EdgePredicate.tex
    R parseAPI/doc/API/FuncExtent.tex
    R parseAPI/doc/API/Function.tex
    R parseAPI/doc/API/Loop.tex
    R parseAPI/doc/API/LoopTreeNode.tex
    R parseAPI/doc/API/ParseCallback.tex
    R parseAPI/doc/README
    R parseAPI/doc/paradyn_logo.pdf
    R parseAPI/doc/parseAPI.tex
    R patchAPI/doc/Makefile.doc
    R patchAPI/doc/figure/abstraction/img.eps
    R patchAPI/doc/figure/abstraction/img.graffle
    R patchAPI/doc/figure/abstraction/img.pdf
    R patchAPI/doc/figure/command/img.graffle
    R patchAPI/doc/figure/command/img.pdf
    R patchAPI/doc/paradyn_logo.pdf
    R patchAPI/doc/patchAPI.tex
    R patchAPI/doc/section/1_intro.tex
    R patchAPI/doc/section/2_abs.tex
    R patchAPI/doc/section/3_example.tex
    R patchAPI/doc/section/4_api_public.tex
    R patchAPI/doc/section/5_api_modification.tex
    R patchAPI/doc/section/6_api_plugin.tex
    R patchAPI/doc/section/7_dyninst.tex
    R stackwalk/doc/.gitignore
    R stackwalk/doc/1-Introduction.tex
    R stackwalk/doc/2-Abstractions.tex
    R stackwalk/doc/3-API.tex
    R stackwalk/doc/4-Callbacks.tex
    R stackwalk/doc/API/Frame.tex
    R stackwalk/doc/API/FrameStepper.tex
    R stackwalk/doc/API/ProcessState.tex
    R stackwalk/doc/API/StepperGroup.tex
    R stackwalk/doc/API/SymbolLookup.tex
    R stackwalk/doc/API/Walker.tex
    R stackwalk/doc/fig/layout-armv8.tex
    R stackwalk/doc/fig/layout.tex
    R stackwalk/doc/fig/object-ownership.tex
    R stackwalk/doc/paradyn_logo.pdf
    R stackwalk/doc/stackwalk.tex
    R symtabAPI/doc/.gitignore
    R symtabAPI/doc/1-Intro.tex
    R symtabAPI/doc/2-Abstractions.tex
    R symtabAPI/doc/4-Definitions.tex
    R symtabAPI/doc/5-Namespace.tex
    R symtabAPI/doc/6-SymtabAPI.tex
    R symtabAPI/doc/7-LineNumberInterface.tex
    R symtabAPI/doc/8-Types.tex
    R symtabAPI/doc/9-Dynamic.tex
    R symtabAPI/doc/A-Appendix.tex
    R symtabAPI/doc/API/LineInfo/Iterating.tex
    R symtabAPI/doc/API/LineInfo/LineInformation.tex
    R symtabAPI/doc/API/LineInfo/Statement.tex
    R symtabAPI/doc/API/Symtab/Archive.tex
    R symtabAPI/doc/API/Symtab/ExceptionBlock.tex
    R symtabAPI/doc/API/Symtab/InlinedFunction.tex
    R symtabAPI/doc/API/Symtab/LocalVar.tex
    R symtabAPI/doc/API/Symtab/Module.tex
    R symtabAPI/doc/API/Symtab/Region.tex
    R symtabAPI/doc/API/Symtab/Symbol.tex
    R symtabAPI/doc/API/Symtab/Symtab.tex
    R symtabAPI/doc/API/Symtab/Variable.tex
    R symtabAPI/doc/API/Symtab/VariableLocation.tex
    R symtabAPI/doc/API/Types/Type.tex
    R symtabAPI/doc/README
    R symtabAPI/doc/paradyn_logo.pdf
    R symtabAPI/doc/symtabAPI.tex

  Log Message:
  -----------
  start of work to refactor the docs to use readthedocs

this is the first pass to format the previous latex into rst. I have done the conversion and
only started to go through ensuring that content is preserved (meaning I did not miss anything)
and all the code blocks are formatted (after the automated conversion they indeed are not!) I
will want a few more hours to finish this up, and then we need to discuss deployment. E.g., I
recommend readthedocs so you can automate deployment and keep versioned docs. We can also deploy
to github pages (I can make a workflow) but I do not have a good suggestion for versioning things
that way. I also have not added in an ability to still render the pdfs if that is desired, which
I think should be possibly. Finally, it would be nice if some of these docs could render from
docstrings - I know how to do this for Python so I wonder if Cpp is that much different. It is
probably terrible because it is cpp, but what can you do?

Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>


  Commit: f40049fe8e9d3760581570833c613ecbef45193d
      https://github.com/dyninst/dyninst/commit/f40049fe8e9d3760581570833c613ecbef45193d
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/_static/theme.css
    M docs/conf.py
    M docs/dataflowAPI/index.rst
    M docs/dynC_API/index.rst
    A docs/instructionAPI/fig/ast_ownership.pdf
    A docs/instructionAPI/fig/decoder_use.pdf
    A docs/instructionAPI/fig/deref-eval.pdf
    A docs/instructionAPI/fig/full_inheritance_graph.pdf
    A docs/instructionAPI/fig/instruction_representation.pdf
    A docs/instructionAPI/fig/ownership_graph.pdf
    A docs/instructionAPI/fig/refman.pdf
    M docs/instructionAPI/index.rst
    M docs/parseAPI/index.rst
    A docs/patchAPI/figure/abstraction/img.pdf
    A docs/patchAPI/figure/command/img.graffle
    A docs/patchAPI/figure/command/img.pdf
    M docs/patchAPI/index.rst
    M docs/stackwalk/index.rst
    M docs/symtabAPI/index.rst

  Log Message:
  -----------
  adding missing figures and re-creating tables in format that will render

Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>


  Commit: c107581b7f2feadb1ed55e1bc9586bed1d0c147f
      https://github.com/dyninst/dyninst/commit/c107581b7f2feadb1ed55e1bc9586bed1d0c147f
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M .github/workflows/libabigail.yaml

  Log Message:
  -----------
  use different version of checkout to get around checkout bug

Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>


  Commit: 9098ddeba8227d5588408685ccbd5ef8933e53a4
      https://github.com/dyninst/dyninst/commit/9098ddeba8227d5588408685ccbd5ef8933e53a4
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M .github/workflows/libabigail.yaml

  Log Message:
  -----------
  try fix for gha

Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>


  Commit: 446e3bdca4547b9da3fcad4e84ab4c179b517e2f
      https://github.com/dyninst/dyninst/commit/446e3bdca4547b9da3fcad4e84ab4c179b517e2f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/conf.py
    M docs/requirements.txt

  Log Message:
  -----------
  Switch to using myst_parser

recommonmark is deprecated
https://stackoverflow.com/questions/62631362/get-rid-of-duplicate-label-warning-in-sphinx


  Commit: 730230e6830600f8770cd3a31806927dfe25d615
      https://github.com/dyninst/dyninst/commit/730230e6830600f8770cd3a31806927dfe25d615
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/conf.py

  Log Message:
  -----------
  Don't auto-label sections

This fixes several spurious 'duplicate section name' warnings.


  Commit: 6ea14177f25962cc473b2f67bfdd29eecca8c592
      https://github.com/dyninst/dyninst/commit/6ea14177f25962cc473b2f67bfdd29eecca8c592
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/conf.py

  Log Message:
  -----------
  Change TOC behavior


  Commit: f3005a2d1c48db47940e22741d22851471b8ba4c
      https://github.com/dyninst/dyninst/commit/f3005a2d1c48db47940e22741d22851471b8ba4c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst

  Log Message:
  -----------
  Make a 'Toolkits' toctree root


  Commit: 15541a5c05a6b369c82027210eb9c161421adcdf
      https://github.com/dyninst/dyninst/commit/15541a5c05a6b369c82027210eb9c161421adcdf
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst

  Log Message:
  -----------
  Update dataflowAPI/index document structure


  Commit: 92906b97225542dc1fdbe216c116196e97dd82bf
      https://github.com/dyninst/dyninst/commit/92906b97225542dc1fdbe216c116196e97dd82bf
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dynC_API/index.rst
    M docs/index.rst

  Log Message:
  -----------
  Update the DynC_API document structure


  Commit: 55eb0267873f6134b862b6921ef16aade90d1f7f
      https://github.com/dyninst/dyninst/commit/55eb0267873f6134b862b6921ef16aade90d1f7f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/instructionAPI/index.rst

  Log Message:
  -----------
  Update instructionAPI document layout


  Commit: dbabeaa1d88689d3cbf922537f7b5604f1674152
      https://github.com/dyninst/dyninst/commit/dbabeaa1d88689d3cbf922537f7b5604f1674152
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/parseAPI/index.rst

  Log Message:
  -----------
  Update parseAPI document structure


  Commit: f8512a41de15dc822cf212ae43066fa730d93ce6
      https://github.com/dyninst/dyninst/commit/f8512a41de15dc822cf212ae43066fa730d93ce6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/patchAPI/index.rst

  Log Message:
  -----------
  Update patchAPI document structure


  Commit: 20089b395236971e5933fe2882de994a2d98d389
      https://github.com/dyninst/dyninst/commit/20089b395236971e5933fe2882de994a2d98d389
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/stackwalk/index.rst

  Log Message:
  -----------
  Update stackwalk document structure


  Commit: 3fd7d538dd0ddd445e1457376d1e33eea9506ea4
      https://github.com/dyninst/dyninst/commit/3fd7d538dd0ddd445e1457376d1e33eea9506ea4
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/symtabAPI/index.rst

  Log Message:
  -----------
  Update symtabAPI document structure


  Commit: 565106b98f77de065dbf4b17973332927e3a0af6
      https://github.com/dyninst/dyninst/commit/565106b98f77de065dbf4b17973332927e3a0af6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    R common/docs/decoding_diagram.png
    R common/docs/rose_structure.png
    R dataflowAPI/README.md
    R dyninstAPI/ClassDiagram1.cd
    R dyninstAPI/README.md
    R dyninstAPI/nosynchfuncs.txt
    R parseAPI/README.md
    R parseThat/.gitignore
    R proccontrol/.syntastic_cpp_config
    R proccontrol/README.md
    R proccontrol/dumplibpthread.asm
    R stackwalk/README.md
    R symlite/README.md
    R symtabAPI/README.md

  Log Message:
  -----------
  Clean up a bunch of unused doc/README files


  Commit: 601cd1aabecea77e72e1e40f0d8614ed562dbcb0
      https://github.com/dyninst/dyninst/commit/601cd1aabecea77e72e1e40f0d8614ed562dbcb0
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    R docs/dynC_API/index.rst
    M docs/index.rst
    A docs/usertools/dynC_API/index.rst

  Log Message:
  -----------
  Move DynC into usertools


  Commit: 29f4ebdbc7985eb85bdac0500726f9f9495a9aad
      https://github.com/dyninst/dyninst/commit/29f4ebdbc7985eb85bdac0500726f9f9495a9aad
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst
    M docs/parseAPI/index.rst
    M docs/patchAPI/index.rst
    M docs/symtabAPI/index.rst

  Log Message:
  -----------
  Rename 'Examples' section to 'Usage'

They aren't really examples. We should make a new toctree for that and
then bring in code from the dyninst/examples repo.


  Commit: 4bd4c49bea4455e8e2238ae22bc9ba0aa52a5606
      https://github.com/dyninst/dyninst/commit/4bd4c49bea4455e8e2238ae22bc9ba0aa52a5606
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    A docs/dataflowAPI/API.rst
    M docs/dataflowAPI/index.rst
    M docs/index.rst
    A docs/instructionAPI/API.rst
    M docs/instructionAPI/index.rst
    A docs/parseAPI/API.rst
    M docs/parseAPI/index.rst
    A docs/patchAPI/API.rst
    M docs/patchAPI/index.rst
    A docs/stackwalk/API.rst
    M docs/stackwalk/index.rst
    A docs/symtabAPI/API.rst
    M docs/symtabAPI/index.rst

  Log Message:
  -----------
  Split all API reference sections into their own file

This makes separating the toctrees much easier and should make maintenance of these API docs easier, too.


  Commit: 359108c78136a897d3cd51ce33af1c46de661fe5
      https://github.com/dyninst/dyninst/commit/359108c78136a897d3cd51ce33af1c46de661fe5
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    A docs/usertools/DynC/index.rst
    R docs/usertools/dynC_API/index.rst

  Log Message:
  -----------
  Rename dynC_API to DynC


  Commit: 83841e22e7c2ff3e8c911019889b61618de4c0e4
      https://github.com/dyninst/dyninst/commit/83841e22e7c2ff3e8c911019889b61618de4c0e4
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    A docs/building.rst
    M docs/index.rst

  Log Message:
  -----------
  Add basic instructions for building Dyninst


  Commit: 1f6f1da61f6a9d689873397bb4e3e1ee94697c35
      https://github.com/dyninst/dyninst/commit/1f6f1da61f6a9d689873397bb4e3e1ee94697c35
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst

  Log Message:
  -----------
  Add description of toolkits and links on the landing page


  Commit: 518ecd3cd226d1788c08838b5118446a35adf439
      https://github.com/dyninst/dyninst/commit/518ecd3cd226d1788c08838b5118446a35adf439
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    A docs/overview.rst

  Log Message:
  -----------
  Add a stub for an overview


  Commit: c7ec2bb25d1096e066b4dddd2e4eb9ec8781c61d
      https://github.com/dyninst/dyninst/commit/c7ec2bb25d1096e066b4dddd2e4eb9ec8781c61d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst

  Log Message:
  -----------
  Update landing page epigraph


  Commit: d056db4f07cdb19b9e855980ed92160b9fb5fa86
      https://github.com/dyninst/dyninst/commit/d056db4f07cdb19b9e855980ed92160b9fb5fa86
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst

  Log Message:
  -----------
  Add acknowledgement on landing page


  Commit: fc18adb25223b5179a84d4d46d054e45df2dca63
      https://github.com/dyninst/dyninst/commit/fc18adb25223b5179a84d4d46d054e45df2dca63
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    A docs/dyninstAPI/API.rst
    A docs/dyninstAPI/index.rst
    M docs/index.rst

  Log Message:
  -----------
  Initial import of dyninstAPI


  Commit: 1592bbc6a0ea1d7b2ba59a53b023a55e6603ba19
      https://github.com/dyninst/dyninst/commit/1592bbc6a0ea1d7b2ba59a53b023a55e6603ba19
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    A docs/proccontrolAPI/API.rst
    A docs/proccontrolAPI/index.rst

  Log Message:
  -----------
  Initial import of proccontrolAPI


  Commit: c69eac0b66cdc0a376fc2cc2ac5192a158954ad9
      https://github.com/dyninst/dyninst/commit/c69eac0b66cdc0a376fc2cc2ac5192a158954ad9
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dyninstAPI/API.rst
    M docs/dyninstAPI/index.rst

  Log Message:
  -----------
  Clean up dyninstAPI


  Commit: fe231439fc91c6ca164ed62b75504dfbc6a84e17
      https://github.com/dyninst/dyninst/commit/fe231439fc91c6ca164ed62b75504dfbc6a84e17
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/overview.rst

  Log Message:
  -----------
  Add content to overview

Still needs more.


  Commit: 8c6c9ec5397caa11a0eb214a6ac1796610e96320
      https://github.com/dyninst/dyninst/commit/8c6c9ec5397caa11a0eb214a6ac1796610e96320
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dataflowAPI/API.rst

  Log Message:
  -----------
  Add c++ domain markup to dataflowAPI


  Commit: cddea963d0a67c9075b231d09e6bbba96ba3b4e9
      https://github.com/dyninst/dyninst/commit/cddea963d0a67c9075b231d09e6bbba96ba3b4e9
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/proccontrolAPI/index.rst

  Log Message:
  -----------
  Add dyninstAPI and proccontrolAPI to landing page


  Commit: 15a0fd8702d7d67a7ca4b7219db9df684e73f7d4
      https://github.com/dyninst/dyninst/commit/15a0fd8702d7d67a7ca4b7219db9df684e73f7d4
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    A docs/.gitignore

  Log Message:
  -----------
  ignore perl scripts


  Commit: d49cf45c93f67eca95ae150fbc6893e7d64af770
      https://github.com/dyninst/dyninst/commit/d49cf45c93f67eca95ae150fbc6893e7d64af770
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst

  Log Message:
  -----------
  Fix intro do dataflowAPI


  Commit: 2b063cd65628eca7abe9a3bcdc0c03d94fb99542
      https://github.com/dyninst/dyninst/commit/2b063cd65628eca7abe9a3bcdc0c03d94fb99542
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst

  Log Message:
  -----------
  dataflowAPI: enumerated list


  Commit: 05a678f585f7866b9cdbbb4159a53a8794669d37
      https://github.com/dyninst/dyninst/commit/05a678f585f7866b9cdbbb4159a53a8794669d37
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    A docs/optimizations.rst
    M docs/overview.rst

  Log Message:
  -----------
  Move optimization discussion to its own section


  Commit: 8305eef6adbf0165995e25a5713ad29cc0aa327c
      https://github.com/dyninst/dyninst/commit/8305eef6adbf0165995e25a5713ad29cc0aa327c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    M docs/overview.rst
    A docs/pitfalls.rst

  Log Message:
  -----------
  Move pitfalls discussion to its own section


  Commit: 3436deb01cfb2db897a3586135bc2980cd574c18
      https://github.com/dyninst/dyninst/commit/3436deb01cfb2db897a3586135bc2980cd574c18
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dyninstAPI/index.rst
    M docs/overview.rst

  Log Message:
  -----------
  Move DyninstAPI intro to overview section


  Commit: 85ca7913e98dab7749c0c6ee6612d1d2cc33459c
      https://github.com/dyninst/dyninst/commit/85ca7913e98dab7749c0c6ee6612d1d2cc33459c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    A docs/first_mutator.rst
    M docs/index.rst

  Log Message:
  -----------
  Add very rough first mutator example


  Commit: 24959bc45a19f007b01632eaeebc565e27e63e7a
      https://github.com/dyninst/dyninst/commit/24959bc45a19f007b01632eaeebc565e27e63e7a
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/dyninstAPI/index.rst
    A docs/examples/binary_analysis.rst
    A docs/examples/cfg.rst
    A docs/examples/function_disassembly.rst
    A docs/examples/instrument_function.rst
    A docs/examples/memory_access.rst
    A docs/examples/retee.rst
    M docs/index.rst
    M docs/parseAPI/index.rst

  Log Message:
  -----------
  Collect examples into their own section

A 'usage' is a short snippet. An 'example' is a complete program.


  Commit: bc4e9ae2a869fd883aae948b03213ccd642e18c4
      https://github.com/dyninst/dyninst/commit/bc4e9ae2a869fd883aae948b03213ccd642e18c4
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst

  Log Message:
  -----------
  Move optimization and pitfalls into 'advanced' section


  Commit: ef48c748abb31e5eecdd06989d31de0f6d365667
      https://github.com/dyninst/dyninst/commit/ef48c748abb31e5eecdd06989d31de0f6d365667
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst
    A docs/using.rst

  Log Message:
  -----------
  Add page on using/importing Dyninst via CMake


  Commit: 34705c256b1689f6734b195cdd45ef0c8d23712e
      https://github.com/dyninst/dyninst/commit/34705c256b1689f6734b195cdd45ef0c8d23712e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    A .github/workflows/docs.yaml

  Log Message:
  -----------
  Add Github action to build docs


  Commit: 1bfb5ac2aaf8e2601ede50a5d3bf512f0c64ebab
      https://github.com/dyninst/dyninst/commit/1bfb5ac2aaf8e2601ede50a5d3bf512f0c64ebab
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/index.rst

  Log Message:
  -----------
  Use numbered headings for toolkits


  Commit: f759934359df7b8185f811043c8c396c2d030a0a
      https://github.com/dyninst/dyninst/commit/f759934359df7b8185f811043c8c396c2d030a0a
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/conf.py
    M docs/requirements.txt

  Log Message:
  -----------
  Update requirements


  Commit: 446c79fb9363aee48591fb5a2887b5c565a90e27
      https://github.com/dyninst/dyninst/commit/446c79fb9363aee48591fb5a2887b5c565a90e27
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-09-08 (Fri, 08 Sep 2023)

  Changed paths:
    M docs/symtabAPI/index.rst

  Log Message:
  -----------
  Remove instructions for building symtabAPI

They are antiquated.


Compare: https://github.com/dyninst/dyninst/compare/f50ac8290502...446c79fb9363