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

Commits:

• 6ba9dd41
  by Wolfgang Jeltsch at 2026-08-13T10:16:07-04:00

  Improve the documentation of `--show-iface`
  
  This change in particular gets rid of the claim that `--show-iface`
  writes *the* contents of the interface file in question. It doesn’t do
  that; it only writes those parts that are likely of interest to a human
  reader.
  

2 changed files:

• docs/users_guide/separate_compilation.rst
• docs/users_guide/using.rst

Changes:

     :type: mode

     :category: interface-files

-    where ⟨file⟩ is the name of an interface file, dumps the contents of

-    that interface in a human-readable format. See :ref:`modes`.

+    where ⟨file⟩ is the name of an interface file, dumps relevant parts

+    of this file’s contents in a human-readable format. See

+    :ref:`modes`.

 .. _hie-options:

     exit.

 .. ghc-flag:: --show-iface ⟨file⟩

-    :shortdesc: display the contents of an interface file.

+    :shortdesc: display contents of an interface file.

     :type: mode

     :category: modes

-    Read the interface in ⟨file⟩ and dump it as text to ``stdout``. For

-    example ``ghc --show-iface M.hi``.

+    Read an interface file and dump relevent parts of it as text to ``stdout``.

 .. ghc-flag:: --supported-extensions

               --supported-languages