From d0d5acb599fda2e4645b4578a3bb7b63e196326c Mon Sep 17 00:00:00 2001 From: Teo Camarasu <teo.camarasu@tracsis.com> Date: Mon, 12 Feb 2024 11:32:38 +0000 Subject: [PATCH] doc: Add requires prof annotation to options that require it Resolves #24421 --- docs/users_guide/profiling.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 03812db8b40..c8c54ca7523 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -951,47 +951,47 @@ follows: .. rts-flag:: -hc ⟨name⟩ :noindex: - Restrict the profile to closures produced by cost-centre stacks with + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures produced by cost-centre stacks with one of the specified cost centres at the top. .. rts-flag:: -hC ⟨name⟩ :noindex: - Restrict the profile to closures produced by cost-centre stacks with + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures produced by cost-centre stacks with one of the specified cost centres anywhere in the stack. .. rts-flag:: -hm ⟨module⟩ :noindex: - Restrict the profile to closures produced by the specified modules. + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures produced by the specified modules. .. rts-flag:: -hd ⟨desc⟩ :noindex: - Restrict the profile to closures with the specified description + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures with the specified description strings. .. rts-flag:: -hy ⟨type⟩ :noindex: - Restrict the profile to closures with the specified types. + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures with the specified types. .. rts-flag:: -he ⟨era⟩ :noindex: - Restrict the profile to the specified era. + *Requires* :ghc-flag:`-prof`. Restrict the profile to the specified era. .. rts-flag:: -hr ⟨cc⟩ :noindex: - Restrict the profile to closures with retainer sets containing + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures with retainer sets containing cost-centre stacks with one of the specified cost centres at the top. .. rts-flag:: -hb ⟨bio⟩ :noindex: - Restrict the profile to closures with one of the specified + *Requires* :ghc-flag:`-prof`. Restrict the profile to closures with one of the specified biographies, where ⟨bio⟩ is one of ``lag``, ``drag``, ``void``, or ``use``. -- GitLab