Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add odoc API documentation #1055

Merged
merged 24 commits into from
May 25, 2023
Merged

Add odoc API documentation #1055

merged 24 commits into from
May 25, 2023

Conversation

sim642
Copy link
Member

@sim642 sim642 commented May 23, 2023 •
edited
Loading

Closes #1054.

This adds a GitHub Actions workflow that builds Goblint's OCaml API documentation with odoc and publishes it to https://goblint.github.io/analyzer/.

In order to be actually useful, the Goblint_lib module is manually written to organize all the modules in our huge flat namespace. Moreover, ocamldoc synopses are added for all those modules.

TODO

  • Change workflow branch to master before merging.

@sim642 sim642 added the documentation Documentation, comments label May 23, 2023
@sim642 sim642 temporarily deployed to github-pages May 23, 2023 14:23 — with GitHub Actions Inactive
@sim642 sim642 temporarily deployed to github-pages May 24, 2023 10:01 — with GitHub Actions Inactive
@michael-schwarz michael-schwarz self-requested a review May 24, 2023 13:22
michael-schwarz
michael-schwarz requested changes May 24, 2023
View reviewed changes
src/analyses/abortUnless.ml Outdated Show resolved Hide resolved
src/analyses/commonPriv.ml Outdated Show resolved Hide resolved
src/analyses/expRelation.ml Outdated Show resolved Hide resolved
src/analyses/expRelation.ml Outdated Show resolved Hide resolved
src/analyses/expsplit.ml Outdated Show resolved Hide resolved
src/framework/edge.ml Show resolved Hide resolved
src/framework/varQuery.mli Show resolved Hide resolved
src/solvers/generic.ml Outdated Show resolved Hide resolved
src/witness/argTools.ml Outdated Show resolved Hide resolved
src/witness/myARG.ml Outdated Show resolved Hide resolved
sim642 and others added 4 commits May 24, 2023 17:09
@sim642
Add signs tutorial link to ocamldoc
e238008
@sim642 @michael-schwarz
Fix some ocamldoc typos
cdd47e0 
Co-authored-by: Michael Schwarz <michael.schwarz93@gmail.com>
@sim642 @michael-schwarz
Add some ocamldoc references
c3444ac 
Co-authored-by: Michael Schwarz <michael.schwarz93@gmail.com>
@sim642
Fix some ocamldoc syntax
65f12bb
@sim642 sim642 temporarily deployed to github-pages May 24, 2023 14:45 — with GitHub Actions Inactive
sim642 and others added 2 commits May 24, 2023 17:49
@sim642
Add threadJoins arXiv reference
d2941b9
@sim642 @michael-schwarz
Improve some ocamldoc synopses
2a64ceb 
Co-authored-by: Michael Schwarz <michael.schwarz93@gmail.com>
@sim642 sim642 temporarily deployed to github-pages May 24, 2023 15:03 — with GitHub Actions Inactive
sim642 and others added 2 commits May 25, 2023 11:49
@sim642 @michael-schwarz
Improve some ocamldoc synopses
03048e6 
Co-authored-by: Michael Schwarz <michael.schwarz93@gmail.com>
@sim642
Merge branch 'master' into api-docs
58cefe5
@sim642 sim642 temporarily deployed to github-pages May 25, 2023 09:02 — with GitHub Actions Inactive
@sim642 sim642 added this to the v2.2.0 milestone May 25, 2023
@sim642 sim642 merged commit 2e010b3 into master May 25, 2023
@sim642 sim642 deleted the api-docs branch May 25, 2023 09:50
sim642 added a commit that referenced this pull request May 25, 2023
@sim642
Fix indentation (PR #1055)
b9afd1d
@sim642 sim642 mentioned this pull request Sep 13, 2023
Closed
sim642 added a commit to sim642/opam-repository that referenced this pull request Sep 13, 2023
@sim642
[new release] goblint (2.2.0)
eb80bce 
CHANGES:

* Add `setjmp`/`longjmp` analysis (goblint/analyzer#887, goblint/analyzer#970, goblint/analyzer#1015, goblint/analyzer#1019).
* Refactor race analysis to lazy distribution (goblint/analyzer#1084, goblint/analyzer#1089, goblint/analyzer#1136, goblint/analyzer#1016).
* Add thread-unsafe library function call analysis (goblint/analyzer#723, goblint/analyzer#1082).
* Add mutex type analysis and mutex API analysis (goblint/analyzer#800, goblint/analyzer#839, goblint/analyzer#1073).
* Add interval set domain and string literals domain (goblint/analyzer#901, goblint/analyzer#966, goblint/analyzer#994, goblint/analyzer#1048).
* Add affine equalities analysis (goblint/analyzer#592).
* Add use-after-free analysis (goblint/analyzer#1050, goblint/analyzer#1114).
* Add dead code elimination transformation (goblint/analyzer#850, goblint/analyzer#979).
* Add taint analysis for partial contexts (goblint/analyzer#553, goblint/analyzer#952).
* Add YAML witness validation via unassume (goblint/analyzer#796, goblint/analyzer#977, goblint/analyzer#1044, goblint/analyzer#1045, goblint/analyzer#1124).
* Add incremental analysis rename detection (goblint/analyzer#774, goblint/analyzer#777).
* Fix address sets unsoundness (goblint/analyzer#822, goblint/analyzer#967, goblint/analyzer#564, goblint/analyzer#1032, goblint/analyzer#998, goblint/analyzer#1031).
* Fix thread escape analysis unsoundness (goblint/analyzer#939, goblint/analyzer#984, goblint/analyzer#1074, goblint/analyzer#1078).
* Fix many incremental analysis issues (goblint/analyzer#627, goblint/analyzer#836, goblint/analyzer#835, goblint/analyzer#841, goblint/analyzer#932, goblint/analyzer#678, goblint/analyzer#942, goblint/analyzer#949, goblint/analyzer#950, goblint/analyzer#957, goblint/analyzer#955, goblint/analyzer#954, goblint/analyzer#960, goblint/analyzer#959, goblint/analyzer#1004, goblint/analyzer#558, goblint/analyzer#1010, goblint/analyzer#1091).
* Fix server mode for abstract debugging (goblint/analyzer#983, goblint/analyzer#990, goblint/analyzer#997, goblint/analyzer#1000, goblint/analyzer#1001, goblint/analyzer#1013, goblint/analyzer#1018, goblint/analyzer#1017, goblint/analyzer#1026, goblint/analyzer#1027).
* Add documentation for configuration JSON schema and OCaml API (goblint/analyzer#999, goblint/analyzer#1054, goblint/analyzer#1055, goblint/analyzer#1053).
* Add many library function specifications (goblint/analyzer#962, goblint/analyzer#996, goblint/analyzer#1028, goblint/analyzer#1079, goblint/analyzer#1121, goblint/analyzer#1135, goblint/analyzer#1138).
* Add OCaml 5.0 support (goblint/analyzer#1003, goblint/analyzer#945, goblint/analyzer#1162).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michael-schwarz michael-schwarz michael-schwarz approved these changes

Assignees
No one assigned
Labels
documentation Documentation, comments
Projects
None yet
Milestone
v2.2.0
Development

Successfully merging this pull request may close these issues.

API documentation
2 participants
@sim642 @michael-schwarz