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


Date: Wed, 14 Dec 2022 15:17:21 -0800
From: Tim Haines <noreply@xxxxxxxxxx>
Subject: [DynInst_API:] [dyninst/dyninst] 4a1768: start of work to refactor the docs to use readthedocs
  Branch: refs/heads/thaines/documentation_modernization
  Home:   https://github.com/dyninst/dyninst
  Commit: 4a176880eaf2f5396f73ae8f6517e4f92a93fd83
      https://github.com/dyninst/dyninst/commit/4a176880eaf2f5396f73ae8f6517e4f92a93fd83
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  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/code_sample.cc
    R parseAPI/doc/example.cc
    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/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.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: 8e9c4ad8e35a72cc72e602fa83a9b48c62162d6e
      https://github.com/dyninst/dyninst/commit/8e9c4ad8e35a72cc72e602fa83a9b48c62162d6e
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 74a7d5e1258b824c4de2cae7e914bffc7eab9b35
      https://github.com/dyninst/dyninst/commit/74a7d5e1258b824c4de2cae7e914bffc7eab9b35
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 3fa8b8fd840803cf6077190bdd0b242d2aab7403
      https://github.com/dyninst/dyninst/commit/3fa8b8fd840803cf6077190bdd0b242d2aab7403
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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

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


  Commit: 3f75698ff75207075e4f7a01340e94fd004fab1f
      https://github.com/dyninst/dyninst/commit/3f75698ff75207075e4f7a01340e94fd004fab1f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 2ed30e637455a6dca948a3ae76095f4a5d5344d6
      https://github.com/dyninst/dyninst/commit/2ed30e637455a6dca948a3ae76095f4a5d5344d6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/conf.py

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

This fixes several spurious 'duplicate section name' warnings.


  Commit: 6540289804027bb98a01a9f9dadf20bfdbeabbb6
      https://github.com/dyninst/dyninst/commit/6540289804027bb98a01a9f9dadf20bfdbeabbb6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/conf.py

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


  Commit: 165a28bcae327af44b5855fdf5544da68cd26955
      https://github.com/dyninst/dyninst/commit/165a28bcae327af44b5855fdf5544da68cd26955
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: f2fee4f4ca20cec4778bec9dc076732ad25fa6cc
      https://github.com/dyninst/dyninst/commit/f2fee4f4ca20cec4778bec9dc076732ad25fa6cc
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: d0b06243d11688becc51847971b83375a097ae84
      https://github.com/dyninst/dyninst/commit/d0b06243d11688becc51847971b83375a097ae84
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: ff090b1e165aa88863ea3e060f8f0da48f03f34e
      https://github.com/dyninst/dyninst/commit/ff090b1e165aa88863ea3e060f8f0da48f03f34e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 059cbb7c4f38ae35b73292d7408784ed8ab592c6
      https://github.com/dyninst/dyninst/commit/059cbb7c4f38ae35b73292d7408784ed8ab592c6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 9b2f3ca76c1e1440c8ce930026365fa3c2fa1532
      https://github.com/dyninst/dyninst/commit/9b2f3ca76c1e1440c8ce930026365fa3c2fa1532
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 46574af210ef5da8a235c8446b5ad8744da2710d
      https://github.com/dyninst/dyninst/commit/46574af210ef5da8a235c8446b5ad8744da2710d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: f928b5ef3e54dc115ae5365d9e3c4e8812acb13f
      https://github.com/dyninst/dyninst/commit/f928b5ef3e54dc115ae5365d9e3c4e8812acb13f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: cf6fb35da17c4ae420ca9fe882cb40645cc20b0f
      https://github.com/dyninst/dyninst/commit/cf6fb35da17c4ae420ca9fe882cb40645cc20b0f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 774a7251d185ae688e45c4ae99040ed6e82b3d63
      https://github.com/dyninst/dyninst/commit/774a7251d185ae688e45c4ae99040ed6e82b3d63
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 9a292ecdca4e010321649e0a14221b29b2ef1163
      https://github.com/dyninst/dyninst/commit/9a292ecdca4e010321649e0a14221b29b2ef1163
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 2488cdb7baa81d2d88d8850898402d4d902119a3
      https://github.com/dyninst/dyninst/commit/2488cdb7baa81d2d88d8850898402d4d902119a3
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: e56829b1a39cab4c7f4ac096f561f85fdf10b349
      https://github.com/dyninst/dyninst/commit/e56829b1a39cab4c7f4ac096f561f85fdf10b349
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: afc88830bd72c28ecc17c285c30b333303325b0c
      https://github.com/dyninst/dyninst/commit/afc88830bd72c28ecc17c285c30b333303325b0c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 966a6e553aca357d8626ec3a9964b7745a46c9cf
      https://github.com/dyninst/dyninst/commit/966a6e553aca357d8626ec3a9964b7745a46c9cf
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: 663f90c48a547e38a374f1e1b7769c6e25b7613d
      https://github.com/dyninst/dyninst/commit/663f90c48a547e38a374f1e1b7769c6e25b7613d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 1aafe8003e31d331bb0713d4cc22d92c61e34b04
      https://github.com/dyninst/dyninst/commit/1aafe8003e31d331bb0713d4cc22d92c61e34b04
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: aab83b983645480b5deb3de1fea75fe83f3cfb41
      https://github.com/dyninst/dyninst/commit/aab83b983645480b5deb3de1fea75fe83f3cfb41
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: 465db7adf8181a42c3c4fd0b3efd3e3756f6be0b
      https://github.com/dyninst/dyninst/commit/465db7adf8181a42c3c4fd0b3efd3e3756f6be0b
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 96fced4db3b78da23ffd20401f6defeba6b56285
      https://github.com/dyninst/dyninst/commit/96fced4db3b78da23ffd20401f6defeba6b56285
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 8a8e8f9e083924eb33c1d549e6ad2e29345abd5a
      https://github.com/dyninst/dyninst/commit/8a8e8f9e083924eb33c1d549e6ad2e29345abd5a
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 07a9ba2832d27081133e7f5abd5ef1f9d62deef5
      https://github.com/dyninst/dyninst/commit/07a9ba2832d27081133e7f5abd5ef1f9d62deef5
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/overview.rst

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

Still needs more.


  Commit: 34ecaaeec9fa7187c689e675055fa43985f7376d
      https://github.com/dyninst/dyninst/commit/34ecaaeec9fa7187c689e675055fa43985f7376d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/dataflowAPI/API.rst

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


  Commit: 7255e2d7673f7e8faa3c6032d543f56ca33aa07b
      https://github.com/dyninst/dyninst/commit/7255e2d7673f7e8faa3c6032d543f56ca33aa07b
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: cc3d5454431a2bfd47a1e842e55ff575c99c6149
      https://github.com/dyninst/dyninst/commit/cc3d5454431a2bfd47a1e842e55ff575c99c6149
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    A docs/.gitignore

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


  Commit: 5aff2d38f89f6417c64a11b95a1fe2e6f1f2f93f
      https://github.com/dyninst/dyninst/commit/5aff2d38f89f6417c64a11b95a1fe2e6f1f2f93f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: d35116fa0b278565a5c8fac2c2222ce9fd1a1937
      https://github.com/dyninst/dyninst/commit/d35116fa0b278565a5c8fac2c2222ce9fd1a1937
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: 0e513203f0c7a8ad32edab709d5633c6afd64558
      https://github.com/dyninst/dyninst/commit/0e513203f0c7a8ad32edab709d5633c6afd64558
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: fc550045a501cc76805e524726499c6987a6a94e
      https://github.com/dyninst/dyninst/commit/fc550045a501cc76805e524726499c6987a6a94e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: bc2a36b3346ce80ae10f84eeb5fbe25b11129044
      https://github.com/dyninst/dyninst/commit/bc2a36b3346ce80ae10f84eeb5fbe25b11129044
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: af8321ab3a9ff585df963326d246e90a2412a025
      https://github.com/dyninst/dyninst/commit/af8321ab3a9ff585df963326d246e90a2412a025
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: fa5fa4518988d2169a35af5eaae7e5b4211704db
      https://github.com/dyninst/dyninst/commit/fa5fa4518988d2169a35af5eaae7e5b4211704db
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 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: 06ca0c7c056d0f54ad00c87fd3d8413c8a4c69fe
      https://github.com/dyninst/dyninst/commit/06ca0c7c056d0f54ad00c87fd3d8413c8a4c69fe
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/index.rst

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


  Commit: b42e49ebc4e43b02538fa7141bbbae243b8ab1cb
      https://github.com/dyninst/dyninst/commit/b42e49ebc4e43b02538fa7141bbbae243b8ab1cb
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: a21fa3c84e880ad1a4273d04d6d44b44405e9e3f
      https://github.com/dyninst/dyninst/commit/a21fa3c84e880ad1a4273d04d6d44b44405e9e3f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

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

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


  Commit: 1c5b0666ff2ed4940e18bf452966038144a0155c
      https://github.com/dyninst/dyninst/commit/1c5b0666ff2ed4940e18bf452966038144a0155c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2022-12-12 (Mon, 12 Dec 2022)

  Changed paths:
    M docs/index.rst

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


Compare: https://github.com/dyninst/dyninst/compare/434a5afd09c2...1c5b0666ff2e
[← Prev in Thread] Current Thread [Next in Thread→]
  • [DynInst_API:] [dyninst/dyninst] 4a1768: start of work to refactor the docs to use readthedocs, Tim Haines <=