Branch: refs/heads/thaines/documentation_modernization
Home: https://github.com/dyninst/dyninst
Commit: 434a5afd09c2821792c44a68e5088d8401c5e23b
https://github.com/dyninst/dyninst/commit/434a5afd09c2821792c44a68e5088d8401c5e23b
Author: Vanessasaurus <814322+vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Date: 2022-12-12 (Mon, 12 Dec 2022)
Changed paths:
M .github/workflows/libabigail.yaml
M .gitignore
M CMakeLists.txt
M cmake/LanguageStandards.cmake
M cmake/optimization.cmake
M cmake/options.cmake
M cmake/warnings.cmake
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
M docker/Dockerfile
M docker/build.sh
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/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
A docs/instructionAPI/index.rst
A 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
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
M dyninstAPI_RT/CMakeLists.txt
M instructionAPI/CMakeLists.txt
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 (#1256)
* Update dependency versions in base container config
This should have been part of #1211
* Docker: adding a workflow for release (#1219)
Currently we do the entire build from scratch for release, and this strategy was chosen
for the cleanest build. However we can use the same strategy as we do for testing
and take advantage of the base container. This PR adds a workflow to do that
Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Co-authored-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
* Remove usage of DW_AT_MIPS_linkage_name (#1223)
This isn't part of DWARF4 or DWARF5.
Co-authored-by: Tim Haines <thaines@xxxxxxxxxxx>
* Docker: testing workflow to run libabigail (#1220)
Run libabigail's abidiff to detect ABI breakages between the current PR and the last successful build as well as the current PR and the last release.
* testing workflow to run libabigail!
I am not sure if the artifact is extracted relative or not, so will need to update
the workflow to account for that. This is also a new strategy that will try to
do the new build/retrieval of artifacts from previous containers - have not
tried this yet!
Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Co-authored-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Co-authored-by: Tim Haines <thaines.astro@xxxxxxxxx>
* Correctly propagate pc ranges for blocks and local variables (#1226)
- fix valid pc address ranges for local variables that are declared in a
sub-block (brace, try and catch blocks) of their function
- fix Context class's constructors so they correctly initialize and copy
all member (use in-class initialize and default constructors)
* Fix warnings with cmake's MINSIZEREL build type (#1235)
- Explicitly define optimization flags for cmake's MINSIZEREL build
type. Cmake by default includes -DNDEBUG. This results in assert
being defined to do nothing. Dyninst use asserts as a fatal error
reporting mechanism and expects assert to not return if the condition
is always false. If assert can return then many warnings are
produced due to this unexpect path.
- Remove defining NDEBUG for REL build types if using the MSC compiler
* Remove BUILD_RT option (#1238)
When not enabled, the dyninstAPI_RT/cmake_install.cmake isn't present.
This has been broken since it was implemented by e1afc6918 in 2016.
* Add parsing of names for inlined functions in DWARF (#1237)
* Clean up and enhance debug messages
* Add parsing of names for inlined functions
Co-authored-by: Tim Haines <thaines@xxxxxxxxxxx>
* Remove void pointer arithmetic when using Valgrind annotations (#1236)
gcc allows this as an extension by considering sizeof(void) to be 1 (http://gcc.gnu.org/onlinedocs/gcc/Pointer-Arith.html).
* Docker: use more OS packages for dependencies (#1221)
* Docker: use more OS packages for dependencies
This should have been part of #1211.
* Docker: don't build Dyninst through spack for the environment (#1222)
This results in two installations: one in /opt/dyninst-dev/.spack/include and one in /opt/dyninst-dev/install/dyninst. The former is not updated when testing a PR, so causes public header conflicts.
* Docker: use external-tests instead of testsuite in base image (#1209)
This is in preparation for using -Werror when building Dyninst in the Github workflow. The test suite does not currently build cleanly, so we need a different set of tests.
* Docker: make compile warnings fatal (#1242)
* Remove unused git files (#1244)
.gitmodules hasn't been used since the test suite was moved to its own repository.
.github_changelog_generate hasn't been used since v10.0.0
* Improve compiler diagnostic suppression handling (#1239)
- Create compiler specific diagnostic suppression macros to suppress a
type of warning for a region of code that are consistently defined
based on the build environment.
- Replace current multi-line preprocessor #if and #pragma statements
with one macro.
- Add suppression for warnings in instructionAPI/src/Register.C
when using gcc 6-8.
* Remove MSC compiler warning suppressions (#1239)
Likely no longer needed with current MSC compiler and will hide
problems if MSC is used.
- Removed diagnostic suppressing pragmas
- Removed compiler command line suppression options
* Fix frame-larger-than warning (#1239)
- Increase frame size max when using gcc 6 for non-debug builds and
for all debug builds (needed for rhel's gcc) to compile
instructionAPI/src/AMDGPU/cdna2/InstructionDecoder-amdgpu-cdna2.C
* Add cmake option to disable diagnostic suppressions (#1239)
- DYNINST_DISABLE_DIAGNOSTIC_SUPPRESSIONS option: if set,
disable all warning suppressions and frame size limit overrides
* Add compiler warning related cmake options (#1239)
- DYNINST_WARNINGS_AS_ERRORS option: if set, treat warnings as errors
- DYNINST_EXTRA_WARNINGS option: additional warning options to test for
and use if valid with the current compiler
* Remove unneeded #pragma's (#1240)
- Remove once and interface pragmas
- Replace use of "external/stdint-win.h" and "external/inttypes.h" with
<stdint.h> and <inttypes.h>
* remove unused files containing pragmas (#1240)
* Cleanup (remove) ancient linux kernel support (#1241)
- Remove check and message for ancient linux kernel
- Remove support for old mechanism to find process's tasks
* Use bfd linker for LTO (#1248)
The gold linker crashes and is no longer supported.
* Add cmake options for C/C++ language standards (#1246)
Add cmake options to set C/C++ language standard versions used to build
to facilitate testing.
- DYNINST_C_LANGUAGE_STANDARD cmake option: C Standard version
- DYNINST_CXX_LANGUAGE_STANDARD cmake option: C++ Standard version
* Make dyninstAPI_RT files build with standard C (#1246)
- use same language standards as the rest of Dyninst
- define _DEFAULT_SOURCE in some dyninstAPI_RT source files so functions
and macros used are defined when using standard C
* Fix format string errors in stackwalk/callchecker.C (#1250)
These are only present when SW_ANALYSIS_STEPPER=OFF.
* Redo finalization to get correct function boundiaries when (#1249)
there are many tail call correction
* Fix dyninstAPI_RT files to build with older glibc (#1252)
Replace feature test macro _DEFAULT_SOURCE with _GNU_SOURCE to support older version of glibc
* Remove unused build options (#1253)
* Remove BUILD_DOCS
This isn't sufficient to create the documentation as some of it is
contained in MS Word files.
* Remove BUILD_TARBALLS
We don't distrubute tarballs anymore. That's handled by GitHub.
* 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>
* adding missing figures and re-creating tables in format that will render
Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
* use different version of checkout to get around checkout bug
Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
* try fix for gha
Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Signed-off-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Co-authored-by: Tim Haines <thaines.astro@xxxxxxxxx>
Co-authored-by: vsoch <vsoch@xxxxxxxxxxxxxxxxxxxxxxxx>
Co-authored-by: Tim Haines <thaines@xxxxxxxxxxx>
Co-authored-by: kupsch <kupsch@xxxxxxxxxxx>
Co-authored-by: Xiaozhu Meng <mxz297@xxxxxxxxx>
|
![[Computer Systems Lab]](https://www-auth.cs.wisc.edu/pics/csl_logo.gif){kind=logo}