[Git][ghc/ghc][master] base: fix haddock syntax in GHC.Profiling
Marge Bot (@marge-bot)
gitlab at gitlab.haskell.org
Fri Jul 14 20:29:18 UTC 2023
Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC
Commits:
e10556b6 by Teo Camarasu at 2023-07-14T16:28:46-04:00
base: fix haddock syntax in GHC.Profiling
- - - - -
1 changed file:
- libraries/base/GHC/Profiling.hs
Changes:
=====================================
libraries/base/GHC/Profiling.hs
=====================================
@@ -27,6 +27,7 @@ foreign import ccall startProfTimer :: IO ()
-- | Request a heap census on the next context switch. The census can be
-- requested whether or not the heap profiling timer is running.
+--
-- Note: This won't do anything unless you also specify a profiling mode on the
-- command line using the normal RTS options.
--
@@ -34,7 +35,8 @@ foreign import ccall startProfTimer :: IO ()
foreign import ccall requestHeapCensus :: IO ()
-- | Start heap profiling. This is called normally by the RTS on start-up,
--- but can be disabled using the rts flag `--no-automatic-heap-samples`
+-- but can be disabled using the rts flag @--no-automatic-heap-samples at .
+--
-- Note: This won't do anything unless you also specify a profiling mode on the
-- command line using the normal RTS options.
--
@@ -42,6 +44,7 @@ foreign import ccall requestHeapCensus :: IO ()
foreign import ccall startHeapProfTimer :: IO ()
-- | Stop heap profiling.
+--
-- Note: This won't do anything unless you also specify a profiling mode on the
-- command line using the normal RTS options.
--
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/e10556b6dc5a04b36cd1f28bbcc16a346895ebac
--
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/e10556b6dc5a04b36cd1f28bbcc16a346895ebac
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/20230714/cdfc0081/attachment-0001.html>
More information about the ghc-commits
mailing list