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.

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

Proper README/documentation #6

Open
zehanort opened this issue Mar 20, 2020 · 4 comments
Open

Proper README/documentation #6

zehanort opened this issue Mar 20, 2020 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@zehanort
Copy link
Owner

zehanort commented Mar 20, 2020

Must include the following, at least:

  • system requirements ☑
  • installation ☑
  • usage ☑
  • limitations & known issues ☑
  • license ☑
@zehanort zehanort added the documentation Improvements or additions to documentation label Mar 20, 2020
@zehanort zehanort added this to the first release milestone Mar 20, 2020
@zehanort
Copy link
Owner Author

zehanort commented Jun 9, 2020

Must reflect all the latest changes; must update usage examples; add some GIPHYs; create a wiki for the documentation of both the command line tool and the package API.

@zehanort zehanort self-assigned this Jun 9, 2020
@zehanort
Copy link
Owner Author

zehanort commented Jun 11, 2020

known issues:

  1. if kernel is prone to segfault, some times produces empty output (if lucky) or freezes for ever and must be killed
  2. when the kernel is profile (i.e. instcounts) it is compiled and ran with NO optimizations (optimizations are normally used in all other modes)

THINKS IT IS CACHED BUT IT IS NOT: 1. time it (with --clear-cache to be sure) 2. instcounts and it breaks, because it thinks it is already instrumented and cached, which is wrong

@zehanort
Copy link
Owner Author

cache bug fixed

@zehanort
Copy link
Owner Author

almost done, must add the following in the wiki:

  1. how oclude works (very briefly, but must refer to source code instrumentation, for example)
  2. cache related thingies

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant