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


Date: Thu, 02 Mar 2023 13:51:51 -0800
From: Tim Haines <noreply@xxxxxxxxxx>
Subject: [DynInst_API:] [dyninst/dyninst] cb2393: start of work to refactor the docs to use readthedocs
  Branch: refs/heads/thaines/documentation_modernization
  Home:   https://github.com/dyninst/dyninst
  Commit: cb23934fcdfebb74565f28cfb6fbe1358f440c2f
      https://github.com/dyninst/dyninst/commit/cb23934fcdfebb74565f28cfb6fbe1358f440c2f
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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/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: b97e23f12d7da7aaf75082c529b41ce6936fb1bc
      https://github.com/dyninst/dyninst/commit/b97e23f12d7da7aaf75082c529b41ce6936fb1bc
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: e552ead21b5187589b90091f315087e8993c5fd7
      https://github.com/dyninst/dyninst/commit/e552ead21b5187589b90091f315087e8993c5fd7
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 19dd2410ba07b13fbbd3b92da85bef5c202aace7
      https://github.com/dyninst/dyninst/commit/19dd2410ba07b13fbbd3b92da85bef5c202aace7
  Author: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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

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


  Commit: a22917e8aa51768d2f1a0e3844d93ad8424b72ff
      https://github.com/dyninst/dyninst/commit/a22917e8aa51768d2f1a0e3844d93ad8424b72ff
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 509d800dfac7bd5418ad097d0916cdb907d81645
      https://github.com/dyninst/dyninst/commit/509d800dfac7bd5418ad097d0916cdb907d81645
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/conf.py

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

This fixes several spurious 'duplicate section name' warnings.


  Commit: 7719bb18b8613dd33fb891c717907ae9d483f80b
      https://github.com/dyninst/dyninst/commit/7719bb18b8613dd33fb891c717907ae9d483f80b
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/conf.py

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


  Commit: 25c6ca7c3ff4eeee82f319d36906292499278cca
      https://github.com/dyninst/dyninst/commit/25c6ca7c3ff4eeee82f319d36906292499278cca
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/index.rst

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


  Commit: 453eb950f09390f96675974dbd730bb9bb46863e
      https://github.com/dyninst/dyninst/commit/453eb950f09390f96675974dbd730bb9bb46863e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: f9afc8f258bee70688ed4f47aaf3d0cee285c86a
      https://github.com/dyninst/dyninst/commit/f9afc8f258bee70688ed4f47aaf3d0cee285c86a
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: bc22256ce083a04dae431274c432b525691dd05e
      https://github.com/dyninst/dyninst/commit/bc22256ce083a04dae431274c432b525691dd05e
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: e45947888d48d9bb506fdf0e8185a08edf34395d
      https://github.com/dyninst/dyninst/commit/e45947888d48d9bb506fdf0e8185a08edf34395d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: d8346dc3658e16bd0a10d68e304dda406fbf2e30
      https://github.com/dyninst/dyninst/commit/d8346dc3658e16bd0a10d68e304dda406fbf2e30
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 6f319e60590a4c6ed834f7174e4a6dbca9f05888
      https://github.com/dyninst/dyninst/commit/6f319e60590a4c6ed834f7174e4a6dbca9f05888
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: e068082e07fbf7185c7c252aba334b9d291489f2
      https://github.com/dyninst/dyninst/commit/e068082e07fbf7185c7c252aba334b9d291489f2
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 4bbaa0df74dc37d231d535cfc698663b2840f431
      https://github.com/dyninst/dyninst/commit/4bbaa0df74dc37d231d535cfc698663b2840f431
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 3a695e54bd2d5b2343086aba6001bc155ab173bd
      https://github.com/dyninst/dyninst/commit/3a695e54bd2d5b2343086aba6001bc155ab173bd
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 19503bdba94c5f6787246b6b4f198d718166a6dd
      https://github.com/dyninst/dyninst/commit/19503bdba94c5f6787246b6b4f198d718166a6dd
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 3b614a4608603fe8558fc46e0c545e089ee08864
      https://github.com/dyninst/dyninst/commit/3b614a4608603fe8558fc46e0c545e089ee08864
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 9255f2276e481b78e0a666ea05ec5733c7fce842
      https://github.com/dyninst/dyninst/commit/9255f2276e481b78e0a666ea05ec5733c7fce842
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 14b0300845f5c3b2b7657fd999c92075232f3695
      https://github.com/dyninst/dyninst/commit/14b0300845f5c3b2b7657fd999c92075232f3695
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 707a3c0fa21c41e6de487c91d9f650bca993a876
      https://github.com/dyninst/dyninst/commit/707a3c0fa21c41e6de487c91d9f650bca993a876
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/index.rst

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


  Commit: 231e000bd50a5f02ae54096f980b4c0917ab3d7c
      https://github.com/dyninst/dyninst/commit/231e000bd50a5f02ae54096f980b4c0917ab3d7c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: a9f15c9fd551e601ab77b31a51426e29fe545f6c
      https://github.com/dyninst/dyninst/commit/a9f15c9fd551e601ab77b31a51426e29fe545f6c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/index.rst

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


  Commit: b4ba43d1ba458057dcb6cb5d64113e1beb2ac473
      https://github.com/dyninst/dyninst/commit/b4ba43d1ba458057dcb6cb5d64113e1beb2ac473
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/index.rst

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


  Commit: 6af6e443da299f4f3797b4d6271304bbe5e0f245
      https://github.com/dyninst/dyninst/commit/6af6e443da299f4f3797b4d6271304bbe5e0f245
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: c99c05be055e95c31b1aa3512e2419385e48f8dc
      https://github.com/dyninst/dyninst/commit/c99c05be055e95c31b1aa3512e2419385e48f8dc
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 17d4b681a145e3ff9173d11da1265ae4a2f795ac
      https://github.com/dyninst/dyninst/commit/17d4b681a145e3ff9173d11da1265ae4a2f795ac
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 51d30f356d4c8e06d56e47224339c739bf817762
      https://github.com/dyninst/dyninst/commit/51d30f356d4c8e06d56e47224339c739bf817762
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/overview.rst

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

Still needs more.


  Commit: 60ee758443dc28ed81fa674d113e9476b4e3f704
      https://github.com/dyninst/dyninst/commit/60ee758443dc28ed81fa674d113e9476b4e3f704
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/dataflowAPI/API.rst

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


  Commit: 72e12b96c56572d751569ebf6845d59627b6b05b
      https://github.com/dyninst/dyninst/commit/72e12b96c56572d751569ebf6845d59627b6b05b
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 909e5ad37cdc712e637dc5ee4980a3a74302382f
      https://github.com/dyninst/dyninst/commit/909e5ad37cdc712e637dc5ee4980a3a74302382f
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    A docs/.gitignore

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


  Commit: ba9df7ceaefe510c24b1af1f4d397d717b586127
      https://github.com/dyninst/dyninst/commit/ba9df7ceaefe510c24b1af1f4d397d717b586127
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: 0a8e058fbb4711fc03ea9f86203c783e128712a6
      https://github.com/dyninst/dyninst/commit/0a8e058fbb4711fc03ea9f86203c783e128712a6
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/dataflowAPI/index.rst

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


  Commit: f885023d3be9e4f57ad0db927bb50d8525b5a30d
      https://github.com/dyninst/dyninst/commit/f885023d3be9e4f57ad0db927bb50d8525b5a30d
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 14430aebc26a1060df1a447bc02f23c0f273c5b3
      https://github.com/dyninst/dyninst/commit/14430aebc26a1060df1a447bc02f23c0f273c5b3
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 87ecd10da46caceed47774513a00e7160f488f1c
      https://github.com/dyninst/dyninst/commit/87ecd10da46caceed47774513a00e7160f488f1c
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 8716dc4240412362b615fb50c317b8f6e55c761a
      https://github.com/dyninst/dyninst/commit/8716dc4240412362b615fb50c317b8f6e55c761a
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 882f34d2237df0272669fcbba5e3e6420ee2acfb
      https://github.com/dyninst/dyninst/commit/882f34d2237df0272669fcbba5e3e6420ee2acfb
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 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: 3a789f1a6c6dacd3fb092df4a901e0e0f81865c7
      https://github.com/dyninst/dyninst/commit/3a789f1a6c6dacd3fb092df4a901e0e0f81865c7
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/index.rst

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


  Commit: 72e97d3b6fbaeb81f8844c20ef1dcf1ae62d61d0
      https://github.com/dyninst/dyninst/commit/72e97d3b6fbaeb81f8844c20ef1dcf1ae62d61d0
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: f4f656eb5d84d287df1c537c21157276cf2975cc
      https://github.com/dyninst/dyninst/commit/f4f656eb5d84d287df1c537c21157276cf2975cc
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


  Commit: 1117b5a9fcd8bda4a809b391048ad64c127442a5
      https://github.com/dyninst/dyninst/commit/1117b5a9fcd8bda4a809b391048ad64c127442a5
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

  Changed paths:
    M docs/index.rst

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


  Commit: f50ac82905021ae8927b214b27e23f116bf10502
      https://github.com/dyninst/dyninst/commit/f50ac82905021ae8927b214b27e23f116bf10502
  Author: Tim Haines <thaines.astro@xxxxxxxxx>
  Date:   2023-03-02 (Thu, 02 Mar 2023)

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

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


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