[Git][ghc/ghc][master] doc: Add requires prof annotation to options that require it

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
d0d5acb5 by Teo Camarasu at 2024-02-12T18:51:09-05:00
doc: Add requires prof annotation to options that require it

Resolves #24421

- - - - -


1 changed file:

- docs/users_guide/profiling.rst


Changes:

=====================================
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``.
 



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/d0d5acb599fda2e4645b4578a3bb7b63e196326c

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/d0d5acb599fda2e4645b4578a3bb7b63e196326c
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240212/ec85b54a/attachment-0001.html>