summaryrefslogtreecommitdiff
path: root/docs/users_guide
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2022-02-05 18:58:47 -0500
committerBen Gamari <ben@smart-cactus.org>2022-02-07 19:23:47 -0500
commitf020a22211f7b28b98c673abbc608076f2e26827 (patch)
treea42900f025d0156addf21f946a1f39b4f6260de0 /docs/users_guide
parent27581d77d489119da5dc1104793503b10240660d (diff)
downloadhaskell-wip/merge-objs-mode.tar.gz
Rename -merge-objs flag to --merge-objswip/merge-objs-mode
For consistency with --make and friends.
Diffstat (limited to 'docs/users_guide')
-rw-r--r--docs/users_guide/ghci.rst2
-rw-r--r--docs/users_guide/using.rst2
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/users_guide/ghci.rst b/docs/users_guide/ghci.rst
index 9995814920..cb98b15f6a 100644
--- a/docs/users_guide/ghci.rst
+++ b/docs/users_guide/ghci.rst
@@ -3497,7 +3497,7 @@ When invoked in the static way, GHCi will use the GHC RTS's static runtime
linker to load object files for imported modules when available. However, when
these modules are built with :ghc-flag:`-split-sections` this linking can be
quite expensive. To reduce this cost, package managers and build systems may
-opt to produce a pre-linked *GHCi object* using the :ghc-flag:`-merge-objs`
+opt to produce a pre-linked *GHCi object* using the :ghc-flag:`--merge-objs`
mode. This merges the per-module objects into a single object, collapsing
function sections into a single text section which can be efficiently loaded by
the runtime linker.
diff --git a/docs/users_guide/using.rst b/docs/users_guide/using.rst
index ec62096cd1..628dfab0f3 100644
--- a/docs/users_guide/using.rst
+++ b/docs/users_guide/using.rst
@@ -345,7 +345,7 @@ The available mode flags are:
compile source files one at a time, or link objects together into an
executable. See :ref:`options-order`.
-.. ghc-flag:: -merge-objs
+.. ghc-flag:: --merge-objs
:shortdesc: Merge a set of objects into a GHCi library.
:type: mode
:category: phases