diff options
author | Ben Gamari <ben@smart-cactus.org> | 2020-01-24 14:24:21 -0500 |
---|---|---|
committer | Ben Gamari <ben@smart-cactus.org> | 2020-02-14 10:16:37 -0500 |
commit | f7f7a556f9b89303da4e1c3475e618653d830cc4 (patch) | |
tree | be1050591219bd5b67de827d2454755812d9f89e /docs | |
parent | 49be2a3fc5e9f6ca71717cde6889c49dbba816da (diff) | |
download | haskell-f7f7a556f9b89303da4e1c3475e618653d830cc4.tar.gz |
users-guide: Fix unknown link targets
Diffstat (limited to 'docs')
-rw-r--r-- | docs/users_guide/8.10.1-notes.rst | 4 | ||||
-rw-r--r-- | docs/users_guide/runtime_control.rst | 19 |
2 files changed, 17 insertions, 6 deletions
diff --git a/docs/users_guide/8.10.1-notes.rst b/docs/users_guide/8.10.1-notes.rst index 8bb5f62533..ca956c70f1 100644 --- a/docs/users_guide/8.10.1-notes.rst +++ b/docs/users_guide/8.10.1-notes.rst @@ -217,8 +217,8 @@ Compiler and much more. See the :ref:`user guide <dynflags_plugins>` for more details as well as an example. -- Deprecated flag :ghc-flag:`-fmax-pmcheck-iterations` in favor of - :ghc-flag:`-fmax-pmcheck-models`, which uses a completely different mechanism. +- Deprecated flag ``-fmax-pmcheck-iterations`` in favor of + :ghc-flag:`-fmax-pmcheck-models=⟨n⟩`, which uses a completely different mechanism. GHCi ~~~~ diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index 522aa72ce7..f94c584690 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -207,21 +207,32 @@ Furthermore GHC lets you specify the way event log data (see :rts-flag:`-l To use an :c:type:`EventLogWriter` the RTS API provides the following functions: -.. c:func:: enum EventLogStatus eventLogStatus(void) +.. c:function:: EventLogStatus eventLogStatus(void) Query whether the current runtime system supports the eventlog (e.g. whether the current executable was linked with :ghc-flag:`-eventlog`) and, if it is supported, whether it is currently logging. -.. c:func:: bool startEventLogging(const EventLogWriter *writer) +.. c:function:: bool startEventLogging(const EventLogWriter *writer) Start logging events to the given :c:type:`EventLogWriter`. Returns true on success or false is another writer has already been configured. -.. c:func:: void endEventLogging() +.. c:function:: void endEventLogging() Tear down the active :c:type:`EventLogWriter`. +where the ``enum`` :c:type:`EventLogStatus` is: + +.. c:type:: EventLogStatus + + * ``EVENTLOG_NOT_SUPPORTED``: The runtime system wasn't compiled with + eventlog support. + * ``EVENTLOG_NOT_CONFIGURED``: An :c:type:`EventLogWriter` has not yet been + configured. + * ``EVENTLOG_RUNNING``: An :c:type:`EventLogWriter` has been configured and + is running. + .. _rts-options-misc: @@ -372,7 +383,7 @@ performance. collections. Under this collection strategy oldest-generation garbage collection can proceed concurrently with mutation. - Note that :rts-flag:`-nonmoving-gc` cannot be used with ``-G1``, + Note that :rts-flag:`--nonmoving-gc` cannot be used with ``-G1``, :rts-flag:`profiling <-hc>` nor :rts-flag:`-c`. .. rts-flag:: -xn |