summaryrefslogtreecommitdiff
path: root/utils/mkUserGuidePart/Main.hs
Commit message (Collapse)AuthorAgeFilesLines
* Rip out mkUserGuidePartBen Gamari2017-08-251-110/+0
| | | | | | | | Reviewers: austin, hvr Subscribers: rwbarton, thomie, erikd Differential Revision: https://phabricator.haskell.org/D3886
* users-guide: Standardize and repair all flag referencesPatrick Dougherty2017-07-231-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch does three things: 1.) It simplifies the flag parsing code in `conf.py` to properly display flag definitions created by `.. (ghc|rts)-flag::`. Additionally, all flag references must include the associated arguments. Documentation has been added to `editing-guide.rst` to explain this. 2.) It normalizes all flag definitions to a similar format. Notably, all instances of `<>` have been replaced with `⟨⟩`. All references across the users guide have been updated to match. 3.) It fixes a couple issues with the flag reference table's generation code, which did not handle comma separated flags in the same cell and did not properly reference flags with arguments. Test Plan: `SPHINXOPTS = -n` to activate "nitpicky" mode, which reports all broken references. All remaining errors are references to flags without any documentation. Reviewers: austin, bgamari Reviewed By: bgamari Subscribers: rwbarton, thomie GHC Trac Issues: #13980 Differential Revision: https://phabricator.haskell.org/D3778
* Remove references to static flags in flag referenceRyan Scott2017-06-021-2/+1
| | | | | | | | | | | | | | | | A follow-up to #8440 (Ditch static flags). There are still some lingering references to static flags in the flag reference, so let's modify those references accordingly. Test Plan: Build the documentation Reviewers: bgamari, austin Reviewed By: bgamari Subscribers: rwbarton, thomie Differential Revision: https://phabricator.haskell.org/D3615
* Spelling fixesGabor Greif2017-02-021-2/+2
|
* mkUserGuide: fix option wrapping in a tableSergei Trofimovich2016-02-101-1/+1
| | | | | | | | | | | | | | | | | | | | Noticed as a sphinx warning: docs/users_guide/flags-warnings.gen.rst:97: WARNING: Inline interpreted text or phrase reference start-string without end-string. Which pointed to broken table. Before the patch table looked like: | :ghc-flag:`-Wno-unticked-promoted-constructors | | ` | After the patch long link is on a single line: | :ghc-flag:`-Wno-unticked-promoted-constructors` | Signed-off-by: Sergei Trofimovich <siarheit@google.com>
* mkUserGuidePart: Better flag cross-referencingBen Gamari2016-01-231-4/+8
|
* Expose enabled language extensions to THBen Gamari2015-12-151-6/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This exposes `template-haskell` functions for querying the language extensions which are enabled when compiling a module, - an `isExtEnabled` function to check whether an extension is enabled - an `extsEnabled` function to obtain a full list of enabled extensions To avoid code duplication this adds a `GHC.LanguageExtensions` module to `ghc-boot` and moves `DynFlags.ExtensionFlag` into it. A happy consequence of this is that the ungainly `DynFlags` lost around 500 lines. Moreover, flags corresponding to language extensions are now clearly distinguished from other flags due to the `LangExt.*` prefix. Updates haddock submodule. This fixes #10820. Test Plan: validate Reviewers: austin, spinda, hvr, goldfire, alanz Reviewed By: goldfire Subscribers: mpickering, RyanGlScott, hvr, simonpj, thomie Differential Revision: https://phabricator.haskell.org/D1200 GHC Trac Issues: #10820
* Build system: Add stage specific SRC_HC_(WARNING_)OPTSThomas Miedema2015-12-011-5/+0
| | | | | | | | | | | | | | | | | | * Add stage specific versions of SRC_HC_OPTS. These are currently only used for -Werror. The previous combination of GhcStage2HcOpts and GhcLibHcOpts didn't apply to utils/*. * Add stage specific versions of SRC_HC_WARNING_OPTS. These will later be used for new warning supression flags that should not be passed to the bootstrap compiler. * Move -Wall (and -Werror) related code back to mk/warnings.mk, where it was before 987d54274. Now all warning related code is nicely together. Include mk/warnings.mk after mk/custom-settings.mk to make this work. Reviewed By: bgamari, hvr Differential Revision: https://phabricator.haskell.org/D1536
* Fix documentation build on windowsTamar Christina2015-10-311-1/+6
| | | | | | | | | | | | | | | | | | | Summary: Fix building new Sphinx documenation on Windows in msys2 using Awson's patch on #11021. Install Sphinx using `pacman -S mingw-w64-$(uname -m)-python2-sphinx` Test Plan: Apply patch and ./validate Reviewers: thomie, bgamari, austin Reviewed By: thomie, bgamari Subscribers: erikd Differential Revision: https://phabricator.haskell.org/D1408 GHC Trac Issues: #11021
* Move user's guide to ReStructuredTextBen Gamari2015-10-031-53/+98
|
* Change how the dblatex/lndir problem is worked aroundIan Lynagh2010-08-241-0/+23
| | | | | | | | | | | Hack: dblatex normalises the name of the main input file using os.path.realpath, which means that if we're in a linked build tree, it find the real source files rather than the symlinks in our link tree. This is fine for the static sources, but it means it can't find the generated sources. We therefore also generate the main input file, so that it really is in the link tree, and thus dblatex can find everything.
* Generate the bit in the user guide where we say what -fglasgow-exts doesIan Lynagh2010-08-221-0/+39
Stops the docs going out of sync with the code.
View Lorry Controller Status