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

Make c/e/fprof clickable links in doc #13290

Merged
merged 3 commits into from
Jan 27, 2024
Merged

Make c/e/fprof clickable links in doc #13290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd35d17
Make c/e/fprof clickable links in doc
sabiwara Jan 27, 2024
d03fcca
Update lib/elixir/pages/getting-started/debugging.md
sabiwara Jan 27, 2024
2fccb1a
Fix links
sabiwara Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/elixir/pages/getting-started/debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ We have just scratched the surface of what the Erlang VM has to offer, for examp

* [Microstate accounting](http://www.erlang.org/doc/man/msacc.html) measures how much time the runtime spends in several low-level tasks in a short time interval

* Mix ships with many tasks under the `profile` namespace, such as `cprof` and `fprof`
* Mix ships with many tasks under the `profile` namespace, such as `mix profile.cprof` and `mix profile.fprof`

* For more advanced use cases, we recommend the excellent [Erlang in Anger](https://www.erlang-in-anger.com/), which is available as a free ebook

Expand Down
2 changes: 1 addition & 1 deletion lib/mix/lib/mix/tasks/profile.cprof.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ defmodule Mix.Tasks.Profile.Cprof do
@moduledoc """
Profiles the given file or expression using Erlang's `cprof` tool.

`cprof` can be useful when you want to discover the bottlenecks related
[`:cprof`](`:cprof`) can be useful when you want to discover the bottlenecks related
to function calls.

Before running the code, it invokes the `app.start` task which compiles
Expand Down
4 changes: 2 additions & 2 deletions lib/mix/lib/mix/tasks/profile.eprof.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ defmodule Mix.Tasks.Profile.Eprof do
@moduledoc """
Profiles the given file or expression using Erlang's `eprof` tool.

`:eprof` provides time information of each function call and can be useful
[`:eprof`](`:eprof`) provides time information of each function call and can be useful
when you want to discover the bottlenecks related to this.

Before running the code, it invokes the `app.start` task which compiles
Expand Down Expand Up @@ -94,7 +94,7 @@ defmodule Mix.Tasks.Profile.Eprof do
some performance impact on the execution, but the impact is considerably lower than
`Mix.Tasks.Profile.Fprof`. If you have a large system try to profile a limited
scenario or focus on the main modules or processes. Another alternative is to use
`Mix.Tasks.Profile.Cprof` that uses `:cprof` and has a low performance degradation effect.
`Mix.Tasks.Profile.Cprof` that uses [`:cprof`](`:cprof`) and has a low performance degradation effect.
"""

@switches [
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/lib/mix/tasks/profile.fprof.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ defmodule Mix.Tasks.Profile.Fprof do
@moduledoc """
Profiles the given file or expression using Erlang's `fprof` tool.

`fprof` can be useful when you want to discover the bottlenecks of a
[`:fprof`](`:fprof`) can be useful when you want to discover the bottlenecks of a
sequential code.

Before running the code, it invokes the `app.start` task which compiles
Expand Down
Loading