Support modules with encrypted debug info #1947
Conversation
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
lib/mix/tasks/docs.ex
Outdated
| extract its documentation without first setting a decryption function or utilizing | ||
| `.erlang.crypt` as prescribed by `m::beam_lib#module-encrypted-debug-information`. Two | ||
| convenience options (see below) are provided to avoid having to call `:beam_lib.crypto_key_fun/1` | ||
| out-of-band and/or to avoid using `.erlang.crypt`. |
There was a problem hiding this comment.
This looks great, but let's support only the .erlang.crypt style for now. The reason for this is because erlang.config files cannot define functions (afaik), so it is not a feature they would be able to use anyway. Let's start with the minimum necessary and expand on that later. WDYT?
There was a problem hiding this comment.
To clarify, you want documentation about .erlang.crypt, but all the other changes should be reverted? Sounds good to me.
Do you want me to add tests or is that not necessary? Adding a test for this could be invasive - either putting a .erlang.crypt file in the root project directory or messing with the XDG_CONFIG_HOME environment variable. I'm leaning toward no, what do you think?
There was a problem hiding this comment.
To clarify, you want documentation about .erlang.crypt, but all the other changes should be reverted? Sounds good to me.
Yes, we will only support .erlang.crypt.
It would be nice to have a test. Perhaps we make it excluded by default but include it on CI?
|
@josevalim hope you had fun 😁 I'll work on scaling this back and should have something for you within the next 48 hours. |
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
|
whoa ew |
Addresses #1928.