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


Date: Wed, 20 Jul 2022 08:27:20 -0700
From: Tim Haines <noreply@xxxxxxxxxx>
Subject: [DynInst_API:] [dyninst/dyninst] f5e0d0: start of work to refactor the docs to use readthedocs
  Branch: refs/heads/thaines/sphinx_updates_round1
  Home:   https://github.com/dyninst/dyninst
  Commit: f5e0d015a9c2d9797edd5cf6f0318f21acaf63f2
      https://github.com/dyninst/dyninst/commit/f5e0d015a9c2d9797edd5cf6f0318f21acaf63f2
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M .gitignore
    R common/doc/manual_commands.tex
    R common/doc/manual_frontpage.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.pdf
    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.pdf
    R dynC_API/doc/dynC_API.tex
    R dynC_API/doc/paradyn_logo.pdf
    R dyninstAPI/doc/dyninstAPI.docx
    R dyninstAPI/doc/dyninstAPI.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.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/code_sample.cc
    R parseAPI/doc/example.cc
    R parseAPI/doc/paradyn_logo.pdf
    R parseAPI/doc/parseAPI.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.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 proccontrol/doc/proccontrol.docx
    R proccontrol/doc/proccontrol.pdf
    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.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/3-Examples.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/Function.tex
    R symtabAPI/doc/API/Symtab/FunctionBase.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.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: 15caaf26a1ba27c5b142a5bfd24cfc892129c8a5
      https://github.com/dyninst/dyninst/commit/15caaf26a1ba27c5b142a5bfd24cfc892129c8a5
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: 5e72ad1d4dd30d4d5030abc443028069e0461baf
      https://github.com/dyninst/dyninst/commit/5e72ad1d4dd30d4d5030abc443028069e0461baf
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: bc46bd017ddd712b95207c6e338b1d4aa26f64b9
      https://github.com/dyninst/dyninst/commit/bc46bd017ddd712b95207c6e338b1d4aa26f64b9
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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

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


  Commit: 9fb5009b411368ba40c98ecb998e0d6b11af0a94
      https://github.com/dyninst/dyninst/commit/9fb5009b411368ba40c98ecb998e0d6b11af0a94
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: 4a7851af04273dc52bf121f3c689bd89e6132baf
      https://github.com/dyninst/dyninst/commit/4a7851af04273dc52bf121f3c689bd89e6132baf
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/conf.py

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

This fixes several spurious 'duplicate section name' warnings.


  Commit: 307b827857954d7cbbf0d5eb4c151870a2114bed
      https://github.com/dyninst/dyninst/commit/307b827857954d7cbbf0d5eb4c151870a2114bed
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/conf.py

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


  Commit: d7437db1a89713ecd1b178cf1d95904c0afc5d44
      https://github.com/dyninst/dyninst/commit/d7437db1a89713ecd1b178cf1d95904c0afc5d44
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: 45ef15ac6ec2504056962e480579ffa3bd7dfd09
      https://github.com/dyninst/dyninst/commit/45ef15ac6ec2504056962e480579ffa3bd7dfd09
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: 57bea35cdb390d9dcc3c6d6c09862ec4ec2d3562
      https://github.com/dyninst/dyninst/commit/57bea35cdb390d9dcc3c6d6c09862ec4ec2d3562
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 45102f84bcba79085958dd07dc4517a74809109d
      https://github.com/dyninst/dyninst/commit/45102f84bcba79085958dd07dc4517a74809109d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 43afc2099a7d9ab06ee68485e2717429fd16675e
      https://github.com/dyninst/dyninst/commit/43afc2099a7d9ab06ee68485e2717429fd16675e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 49b717a5032ee28cd71d7b6c5e12c93b8d219ffa
      https://github.com/dyninst/dyninst/commit/49b717a5032ee28cd71d7b6c5e12c93b8d219ffa
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 57ae0fc883f875d29434c089810cc935c06e539d
      https://github.com/dyninst/dyninst/commit/57ae0fc883f875d29434c089810cc935c06e539d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 569e2e4f8623554ad1501c6cb3b88dc3bc653c88
      https://github.com/dyninst/dyninst/commit/569e2e4f8623554ad1501c6cb3b88dc3bc653c88
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: d3f51677e73cfd296608220e0a21ffe26c51f294
      https://github.com/dyninst/dyninst/commit/d3f51677e73cfd296608220e0a21ffe26c51f294
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: b8766ef29049a51bdd24876c86e75b177ff49986
      https://github.com/dyninst/dyninst/commit/b8766ef29049a51bdd24876c86e75b177ff49986
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: 063e5ebbea0e04d559ff9abccb26014d22bb73e6
      https://github.com/dyninst/dyninst/commit/063e5ebbea0e04d559ff9abccb26014d22bb73e6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: 8ab7837d04f77c0ace4cd7c8b8bab7f7c84a745d
      https://github.com/dyninst/dyninst/commit/8ab7837d04f77c0ace4cd7c8b8bab7f7c84a745d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: ddd5729d4ce829cd3e6382381f2345694b5a13e1
      https://github.com/dyninst/dyninst/commit/ddd5729d4ce829cd3e6382381f2345694b5a13e1
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: d275eea0cca7554cd9a0d5ff727f4ec27b28e3e7
      https://github.com/dyninst/dyninst/commit/d275eea0cca7554cd9a0d5ff727f4ec27b28e3e7
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: c23fa0b6aa7284b8b238e5408cfae357f1b15eb6
      https://github.com/dyninst/dyninst/commit/c23fa0b6aa7284b8b238e5408cfae357f1b15eb6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: 8e9b20a3f7ec82399209eaa3f5f22b2e97667865
      https://github.com/dyninst/dyninst/commit/8e9b20a3f7ec82399209eaa3f5f22b2e97667865
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 0f3bbd2302926cb821c093acc9afc05921733b3e
      https://github.com/dyninst/dyninst/commit/0f3bbd2302926cb821c093acc9afc05921733b3e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: ffc8c3dbf0efb024db4abf12f88125d0a50e79b8
      https://github.com/dyninst/dyninst/commit/ffc8c3dbf0efb024db4abf12f88125d0a50e79b8
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: 5ab29e750fdde952410d0755c30b230908e819db
      https://github.com/dyninst/dyninst/commit/5ab29e750fdde952410d0755c30b230908e819db
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 7946ec40238698ae1e1c744a993b97c301b24fee
      https://github.com/dyninst/dyninst/commit/7946ec40238698ae1e1c744a993b97c301b24fee
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: b3ba7531b85d1f99df8fd6a9836585c0668d660a
      https://github.com/dyninst/dyninst/commit/b3ba7531b85d1f99df8fd6a9836585c0668d660a
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 4cdbbab58438a25cdfd672967645054e6b01527e
      https://github.com/dyninst/dyninst/commit/4cdbbab58438a25cdfd672967645054e6b01527e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/overview.rst

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

Still needs more.


  Commit: b3fa10e78a81ad8ff4c83cd0bd307828353fcc59
      https://github.com/dyninst/dyninst/commit/b3fa10e78a81ad8ff4c83cd0bd307828353fcc59
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/dataflowAPI/API.rst

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


  Commit: 126b550b09ab0092f750c6602838f29a45c3710c
      https://github.com/dyninst/dyninst/commit/126b550b09ab0092f750c6602838f29a45c3710c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 85f69baded19a539e5ee891175c93981500e83cc
      https://github.com/dyninst/dyninst/commit/85f69baded19a539e5ee891175c93981500e83cc
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    A docs/.gitignore

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


  Commit: 62942046fd19f64057006f47d26532ce077e96a4
      https://github.com/dyninst/dyninst/commit/62942046fd19f64057006f47d26532ce077e96a4
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: b7ff6cdf5e0d1adac7007e2b3ed303c64549847b
      https://github.com/dyninst/dyninst/commit/b7ff6cdf5e0d1adac7007e2b3ed303c64549847b
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: 169455d2fba8c564e8f24c2feb46a78df8aa54f7
      https://github.com/dyninst/dyninst/commit/169455d2fba8c564e8f24c2feb46a78df8aa54f7
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 08c6ae2f157d04d40b6806ffc425bf3cce94f91c
      https://github.com/dyninst/dyninst/commit/08c6ae2f157d04d40b6806ffc425bf3cce94f91c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 7be519d4307e91d9f46794b44f4911bda2c28128
      https://github.com/dyninst/dyninst/commit/7be519d4307e91d9f46794b44f4911bda2c28128
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: 0ce61e0a50666b02cf71b9c9d100c42a177d2e73
      https://github.com/dyninst/dyninst/commit/0ce61e0a50666b02cf71b9c9d100c42a177d2e73
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: de6b84521bb102b575ae024c77f19850ddabc6b8
      https://github.com/dyninst/dyninst/commit/de6b84521bb102b575ae024c77f19850ddabc6b8
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  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: 2253d5fe55b6c7a69f3f0391cedd0b5611c66dd3
      https://github.com/dyninst/dyninst/commit/2253d5fe55b6c7a69f3f0391cedd0b5611c66dd3
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: 89c463d271c12137e3e0d1b613e4432ae3b036f8
      https://github.com/dyninst/dyninst/commit/89c463d271c12137e3e0d1b613e4432ae3b036f8
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


  Commit: e407c88c287ad3dd579dde6d4ea0721484d0273c
      https://github.com/dyninst/dyninst/commit/e407c88c287ad3dd579dde6d4ea0721484d0273c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-07-20 (Wed, 20 Jul 2022)

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

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


Compare: https://github.com/dyninst/dyninst/compare/10e12e7b4e75...e407c88c287a
[← Prev in Thread] Current Thread [Next in Thread→]
  • [DynInst_API:] [dyninst/dyninst] f5e0d0: start of work to refactor the docs to use readthedocs, Tim Haines <=