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

No support for debug_info keys? #1928

Open
Olivier-Boudeville opened this issue Jul 1, 2024 · 1 comment · May be fixed by #1949
Open

No support for debug_info keys? #1928

Olivier-Boudeville opened this issue Jul 1, 2024 · 1 comment · May be fixed by #1949

Comments

@Olivier-Boudeville
Copy link

Hi,

Apparently ExDoc does not support (yet) debug_info keys, like used (at least with Erlang) when a module is compiled with: {debug_info_key,KeyString}?

For example, a foo module compiled with such a key, once given to ExDoc, results in:
warning: skipping docs for module :foo, reason: :no_debug_info

(moreover no mention of debug_info keys found with ex_doc -h|grep -i debug, in https://hexdocs.pm/ex_doc/search.html?q=debug_info or in https://github.com/elixir-lang/ex_doc)
@josevalim
Copy link
Member

I believe we indeed don't support it yet. Pull requests welcome!

@voughtdq voughtdq mentioned this issue Aug 13, 2024
Closed
voughtdq added a commit to voughtdq/ex_doc that referenced this issue Aug 30, 2024
@voughtdq
Support modules with encrypted debug info
f052c4f 
Addresses elixir-lang#1928.

- Add configuration options to support decrypting debug info
- Update documentation with new options, examples, and advice
- Update test helper so that debug info options are forwarded to the compiler
- Add basic tests
- Update changelog
voughtdq added a commit to voughtdq/ex_doc that referenced this issue Aug 30, 2024
@voughtdq
Support modules with encrypted debug info
8948c6a 
Addresses elixir-lang#1928.

- Add configuration options to support decrypting debug info
- Update documentation with new options, examples, and advice
- Update test helper so that debug info options are forwarded to the compiler
- Add basic tests
- Update changelog
@voughtdq voughtdq mentioned this issue Aug 30, 2024
Closed
voughtdq pushed a commit to voughtdq/ex_doc that referenced this issue Sep 11, 2024
@wojtekmach @voughtdq
Document how to use ExDoc with encrypted debug info
5599dd1 
Closes elixir-lang#1928.

- Update documentation
- Update test helper so that debug info options are forwarded to the compiler
- Add basic tests
- Update changelog
- Use "CI" environment variable to skip test
voughtdq added a commit to voughtdq/ex_doc that referenced this issue Sep 11, 2024
@voughtdq
Document using .erlang.crypt with ExDoc
fe7a713 
Closes elixir-lang#1928.

- Update documentation
- Update test helper so that debug info options are forwarded to the compiler
- Add basic tests
- Update changelog
- Use "CI" environment variable to skip the encrypted debug info test
@voughtdq voughtdq linked a pull request Sep 11, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
2 participants
@josevalim @Olivier-Boudeville