summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTakenobu Tani <takenobu.hs@gmail.com>2019-03-18 22:07:06 +0900
committerMarge Bot <ben+marge-bot@smart-cactus.org>2019-03-19 23:22:36 -0400
commit89a201e88a9313ecff4f5659c38e40136cfc0b76 (patch)
treee5f8d8e9d53e5285564412619aed9f49d8a67ab7 /docs
parent398f2cbc6af6fcb6135ba2d56c154869bea071a0 (diff)
downloadhaskell-89a201e88a9313ecff4f5659c38e40136cfc0b76.tar.gz
users-guide: Update Wiki URLs to point to GitLab
The user's guide uses the `ghc-wiki` macro, and substitution rules are complicated. So I manually edited `.rst` files without sed. I changed `Commentary/Latedmd` only to a different page. It is more appropriate as an example. [ci skip]
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/8.2.1-notes.rst2
-rw-r--r--docs/users_guide/editing-guide.rst8
-rw-r--r--docs/users_guide/extending_ghc.rst4
-rw-r--r--docs/users_guide/ffi-chap.rst2
-rw-r--r--docs/users_guide/ghc.mk4
-rw-r--r--docs/users_guide/ghc_config.py.in2
-rw-r--r--docs/users_guide/glasgow_exts.rst14
-rw-r--r--docs/users_guide/intro.rst10
-rw-r--r--docs/users_guide/profiling.rst2
-rw-r--r--docs/users_guide/safe_haskell.rst2
-rw-r--r--docs/users_guide/separate_compilation.rst4
-rw-r--r--docs/users_guide/sooner.rst2
-rw-r--r--docs/users_guide/using-optimisation.rst2
13 files changed, 28 insertions, 30 deletions
diff --git a/docs/users_guide/8.2.1-notes.rst b/docs/users_guide/8.2.1-notes.rst
index d46f08dd94..ed159440d9 100644
--- a/docs/users_guide/8.2.1-notes.rst
+++ b/docs/users_guide/8.2.1-notes.rst
@@ -35,7 +35,7 @@ Package system
~~~~~~~~~~~~~~
- The long awaited Backpack module system is now fully usable. See
- :ghc-wiki:`the GHC Wiki <Backpack>` for details.
+ :ghc-wiki:`the GHC Wiki <backpack>` for details.
Language
~~~~~~~~
diff --git a/docs/users_guide/editing-guide.rst b/docs/users_guide/editing-guide.rst
index fcff03b6fe..dbe09eeab8 100644
--- a/docs/users_guide/editing-guide.rst
+++ b/docs/users_guide/editing-guide.rst
@@ -188,9 +188,9 @@ Wiki articles and tickets,
.. code-block:: rest
- See :ghc-wiki:`Commentary/Latedmd` for details on demand analysis.
+ See :ghc-wiki:`commentary/compiler/demand` for details on demand analysis.
- See the :ghc-wiki:`coding style <Commentary/CodingStyle>` for guidelines.
+ See the :ghc-wiki:`coding style <commentary/coding-style>` for guidelines.
See the :ghc-ticket:`123` for further discussion.
@@ -204,11 +204,11 @@ External links can be written in either of these ways,
.. code-block:: rest
- See the `GHC Wiki <http://ghc.haskell.org/wiki>`_ for details.
+ See the `GHC Wiki <https://gitlab.haskell.org/ghc/ghc/wikis>`_ for details.
See the `GHC Wiki`_ for details.
- .. _GHC Wiki: http://ghc.haskell.org/wiki
+ .. _GHC Wiki: https://gitlab.haskell.org/ghc/ghc/wikis
To core library Haddock documentation
diff --git a/docs/users_guide/extending_ghc.rst b/docs/users_guide/extending_ghc.rst
index b1f7b6034c..5908df7bfd 100644
--- a/docs/users_guide/extending_ghc.rst
+++ b/docs/users_guide/extending_ghc.rst
@@ -69,7 +69,7 @@ A number of restrictions apply to use of annotations:
albeit redundant).
If you feel strongly that any of these restrictions are too onerous,
-:ghc-wiki:`please give the GHC team a shout <MailingListsAndIRC>`.
+:ghc-wiki:`please give the GHC team a shout <mailing-lists-and-irc>`.
However, apart from these restrictions, many things are allowed,
including expressions which are not fully evaluated! Annotation
@@ -183,7 +183,7 @@ Plugins cannot optimize/inspect C-\\-, nor can they implement things like
parser/front-end modifications like GCC, apart from limited changes to
the constraint solver. If you feel strongly that any of these
restrictions are too onerous,
-:ghc-wiki:`please give the GHC team a shout <MailingListsAndIRC>`.
+:ghc-wiki:`please give the GHC team a shout <mailing-lists-and-irc>`.
Plugins do not work with ``-fexternal-interpreter``. If you need to run plugins
with ``-fexternal-interpreter`` let GHC developers know in :ghc-ticket:`14335`.
diff --git a/docs/users_guide/ffi-chap.rst b/docs/users_guide/ffi-chap.rst
index 62bad46781..b90b48a672 100644
--- a/docs/users_guide/ffi-chap.rst
+++ b/docs/users_guide/ffi-chap.rst
@@ -120,7 +120,7 @@ or the type ``Any``.
This feature is not intended for use outside of the core libraries that
come with GHC. For more details see the
-:ghc-wiki:`GHC developer wiki <Commentary/PrimOps>`.
+:ghc-wiki:`GHC developer wiki <commentary/prim-ops>`.
.. _ffi-interruptible:
diff --git a/docs/users_guide/ghc.mk b/docs/users_guide/ghc.mk
index c2e20ebc03..af051227fc 100644
--- a/docs/users_guide/ghc.mk
+++ b/docs/users_guide/ghc.mk
@@ -5,8 +5,8 @@
# This file is part of the GHC build system.
#
# To understand how the build system works and how to modify it, see
-# http://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
-# http://ghc.haskell.org/trac/ghc/wiki/Building/Modifying
+# https://gitlab.haskell.org/ghc/ghc/wikis/building/architecture
+# https://gitlab.haskell.org/ghc/ghc/wikis/building/modifying
#
# -----------------------------------------------------------------------------
diff --git a/docs/users_guide/ghc_config.py.in b/docs/users_guide/ghc_config.py.in
index dee8039a5a..0feb916656 100644
--- a/docs/users_guide/ghc_config.py.in
+++ b/docs/users_guide/ghc_config.py.in
@@ -1,6 +1,6 @@
extlinks = {
'ghc-ticket': ('https://gitlab.haskell.org/ghc/ghc/issues/%s', '#'),
- 'ghc-wiki': ('https://ghc.haskell.org/trac/ghc/wiki/%s', '#'),
+ 'ghc-wiki': ('https://gitlab.haskell.org/ghc/ghc/wikis/%s', '#'),
}
libs_base_uri = '../libraries'
diff --git a/docs/users_guide/glasgow_exts.rst b/docs/users_guide/glasgow_exts.rst
index 2b4eb481f9..5a86e877c4 100644
--- a/docs/users_guide/glasgow_exts.rst
+++ b/docs/users_guide/glasgow_exts.rst
@@ -679,7 +679,7 @@ View patterns
View patterns are enabled by the language extension :extension:`ViewPatterns`. More
information and examples of view patterns can be found on the
-:ghc-wiki:`Wiki page <ViewPatterns>`.
+:ghc-wiki:`Wiki page <view-patterns>`.
View patterns are somewhat like pattern guards that can be nested inside
of other patterns. They are a convenient way of pattern-matching against
@@ -4459,7 +4459,7 @@ types containing a function type on the right-hand side.
For a full specification of the algorithms used in :extension:`DeriveFunctor`,
:extension:`DeriveFoldable`, and :extension:`DeriveTraversable`, see
-:ghc-wiki:`this wiki page <Commentary/Compiler/DeriveFunctor>`.
+:ghc-wiki:`this wiki page <commentary/compiler/derive-functor>`.
.. _deriving-data:
@@ -5333,7 +5333,7 @@ Pattern synonyms
Pattern synonyms are enabled by the language extension :extension:`PatternSynonyms`, which is
required for defining them, but *not* for using them. More information and
-examples of pattern synonyms can be found on the :ghc-wiki:`Wiki page <PatternSynonyms>`.
+examples of pattern synonyms can be found on the :ghc-wiki:`Wiki page <pattern-synonyms>`.
Pattern synonyms enable giving names to parametrized pattern schemes.
They can also be thought of as abstract constructors that don't have a
@@ -5535,7 +5535,7 @@ following subsections.
There are also lots more details in the `paper
<https://www.microsoft.com/en-us/research/wp-content/uploads/2016/08/pattern-synonyms-Haskell16.pdf>`_.
-See the :ghc-wiki:`Wiki page <PatternSynonyms>` for more
+See the :ghc-wiki:`Wiki page <pattern-synonyms>` for more
details.
Syntax and scoping of pattern synonyms
@@ -5644,7 +5644,7 @@ incompatible with ``T``.
A module which imports ``MyNum(..)`` from ``Example`` and then re-exports
``MyNum(..)`` will also export any pattern synonyms bundled with ``MyNum`` in
``Example``. A more complete specification can be found on the
-:ghc-wiki:`wiki. <PatternSynonyms/AssociatingSynonyms>`
+:ghc-wiki:`wiki. <pattern-synonyms/associating-synonyms>`
.. _patsyn-typing:
@@ -11498,7 +11498,7 @@ Notice here that the ``Maybe`` type is parameterised by the
should be considered highly experimental, and certainly un-supported*.
You are welcome to try it, but please don't rely on it working
consistently, or working the same in subsequent releases. See
-:ghc-wiki:`this wiki page <ImpredicativePolymorphism>` for more details.
+:ghc-wiki:`this wiki page <impredicative-polymorphism>` for more details.
If you want impredicative polymorphism, the main workaround is to use a
newtype wrapper. The ``id runST`` example can be written using this
@@ -12504,7 +12504,7 @@ that we're interested in is ``main`` it can be useful to be able to
ignore the problems in ``a``.
For more motivation and details please refer to the
-:ghc-wiki:`Wiki <DeferErrorsToRuntime>` page or the `original
+:ghc-wiki:`Wiki <defer-errors-to-runtime>` page or the `original
paper <http://dreixel.net/research/pdf/epdtecp.pdf>`__.
Enabling deferring of type errors
diff --git a/docs/users_guide/intro.rst b/docs/users_guide/intro.rst
index ad6763c8dc..716fc2794e 100644
--- a/docs/users_guide/intro.rst
+++ b/docs/users_guide/intro.rst
@@ -49,7 +49,7 @@ Go to the `GHC home page <http://www.haskell.org/ghc/>`__ and follow the
"download" link to download GHC for your platform.
Alternatively, if you want to build GHC yourself, head on over to the
-:ghc-wiki:`GHC Building Guide <Building>` to find out how to get the sources,
+:ghc-wiki:`GHC Building Guide <building>` to find out how to get the sources,
and build it on your system. Note that GHC itself is written in Haskell, so you
will still need to install GHC in order to build it.
@@ -66,7 +66,7 @@ On the World-Wide Web, there are several URLs of likely interest:
- `GHC home page <http://www.haskell.org/ghc/>`__
-- `GHC Developers Home <http://ghc.haskell.org/trac/ghc/>`__ (developer
+- `GHC Developers Home <https://gitlab.haskell.org/ghc/ghc>`__ (developer
documentation, wiki, and bug tracker)
We run the following mailing lists about GHC. We encourage you to join,
@@ -104,7 +104,7 @@ Reporting bugs in GHC
single: reporting bugs
Glasgow Haskell is a changing system so there are sure to be bugs in it.
-If you find one, please see :ghc-wiki:`this wiki page <ReportABug>` for
+If you find one, please see :ghc-wiki:`this wiki page <report-a-bug>` for
information on how to report it.
.. _version-numbering:
@@ -138,7 +138,7 @@ numbering GHC versions:
`available for
download <http://www.haskell.org/ghc/dist/stable/dist/>`__, and the
latest sources are available from
- :ghc-wiki:`the git repositories <Repositories>`.
+ :ghc-wiki:`the git repositories <repositories>`.
Stable snapshot releases are named ``x.y.z.YYYYMMDD``. where
``YYYYMMDD`` is the date of the sources from which the snapshot was
@@ -149,7 +149,7 @@ numbering GHC versions:
We may make snapshot releases of the HEAD `available for
download <http://www.haskell.org/ghc/dist/current/dist/>`__, and the
latest sources are available from
- :ghc-wiki:`the git repositories <Repositories>`.
+ :ghc-wiki:`the git repositories <repositories>`.
Unstable snapshot releases are named ``x.y.YYYYMMDD``. where
``YYYYMMDD`` is the date of the sources from which the snapshot was
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst
index c1379f3970..1dfe7dd7b0 100644
--- a/docs/users_guide/profiling.rst
+++ b/docs/users_guide/profiling.rst
@@ -1622,7 +1622,7 @@ Using “ticky-ticky” profiling (for implementors)
Because ticky-ticky profiling requires a certain familiarity with GHC
internals, we have moved the documentation to the GHC developers wiki.
Take a look at its
-:ghc-wiki:`overview of the profiling options <Commentary/Profiling>`,
+:ghc-wiki:`overview of the profiling options <commentary/profiling>`,
which includeds a link to the ticky-ticky profiling page.
.. [1]
diff --git a/docs/users_guide/safe_haskell.rst b/docs/users_guide/safe_haskell.rst
index 6772d6abf6..b734fe4743 100644
--- a/docs/users_guide/safe_haskell.rst
+++ b/docs/users_guide/safe_haskell.rst
@@ -810,7 +810,7 @@ taken:
There is a more detailed discussion of the issues involved in
compilation safety and some potential solutions on the
-:ghc-wiki:`GHC Wiki <SafeHaskell/SafeCompilation>`.
+:ghc-wiki:`GHC Wiki <safe-haskell/safe-compilation>`.
Additionally, the use of :ref:`annotations <annotation-pragmas>` is forbidden,
as that would allow bypassing Safe Haskell restrictions. See :ghc-ticket:`10826`
diff --git a/docs/users_guide/separate_compilation.rst b/docs/users_guide/separate_compilation.rst
index 8c997f0942..1c5e34a479 100644
--- a/docs/users_guide/separate_compilation.rst
+++ b/docs/users_guide/separate_compilation.rst
@@ -657,9 +657,7 @@ this time with the fingerprints on the things it needed last time
are all the same it stops compiling early in the process saying
“Compilation IS NOT required”. What a beautiful sight!
-You can read about `how all this
-works <http://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance>`__
-in the GHC commentary.
+You can read about :ghc-wiki:`how all this works <commentary/compiler/recompilation-avoidance>` in the GHC commentary.
.. _mutual-recursion:
diff --git a/docs/users_guide/sooner.rst b/docs/users_guide/sooner.rst
index fbbb61da59..21b280f0dc 100644
--- a/docs/users_guide/sooner.rst
+++ b/docs/users_guide/sooner.rst
@@ -205,7 +205,7 @@ Newtypes are better than datatypes:
Look for your function in the interface file, then for the third
field in the pragma; it should say ``Strictness: ⟨string⟩``. The
⟨string⟩ gives the strictness of the function's arguments: see
- :ghc-wiki:`the GHC Commentary <Commentary/Compiler/Demand>`
+ :ghc-wiki:`the GHC Commentary <commentary/compiler/demand>`
for a description of the strictness notation.
For an "unpackable" ``U(...)`` argument, the info inside tells the
diff --git a/docs/users_guide/using-optimisation.rst b/docs/users_guide/using-optimisation.rst
index 9571c7e4aa..95adb22a11 100644
--- a/docs/users_guide/using-optimisation.rst
+++ b/docs/users_guide/using-optimisation.rst
@@ -509,7 +509,7 @@ by saying ``-fno-wombat``.
that were not visible earlier; and optimisations like
:ghc-flag:`-fspec-constr` can create functions with unused arguments which
are eliminated by late demand analysis. Improvements are modest, but
- so is the cost. See notes on the :ghc-wiki:`wiki page <LateDmd>`.
+ so is the cost. See notes on the :ghc-wiki:`wiki page <late-dmd>`.
.. ghc-flag:: -fliberate-case
:shortdesc: Turn on the liberate-case transformation. Implied by :ghc-flag:`-O2`.