Re: Docs for RTS option -I

2023-11-22 Thread Bryan Richter via ghc-devs
I've now drafted some new documentation at https://gitlab.haskell.org/ghc/ghc/-/merge_requests/11655. Reviews welcome. On Mon, 6 Nov 2023 at 13:13, Bryan Richter wrote: > Thanks! Let's see if I can find the time to make a patch for this. > > On Thu, 2 Nov 2023 at 17:17, Teofil Camarasu > wrote

Re: Docs for RTS option -I

2023-11-06 Thread Bryan Richter via ghc-devs
Thanks! Let's see if I can find the time to make a patch for this. On Thu, 2 Nov 2023 at 17:17, Teofil Camarasu wrote: > Hi Bryan, > > Thanks for improving this documentation! I've often found these flags > to be quite confusing. > > > For an interactive application, it is probably a good idea t

Re: Docs for RTS option -I

2023-11-02 Thread Teofil Camarasu
Hi Bryan, Thanks for improving this documentation! I've often found these flags to be quite confusing. > For an interactive application, it is probably a good idea to use the idle > GC, because this will allow finalizers to run and deadlocked threads to be > detected in the idle time when no Ha

Docs for RTS option -I

2023-11-02 Thread Bryan Richter via ghc-devs
The original docs are here: https://downloads.haskell.org/ghc/latest/docs/users_guide/runtime_control.html#rts-flag--I%20%E2%9F%A8seconds%E2%9F%A9 They raised more questions than answers for me, so I took a stab at rewriting them, and sprinkled in some questions where I need better understanding

can't get docs / sphinx building for ghc 8.4.4

2018-10-26 Thread Carter Schonwald
hello all, i'm getting the following error quite consistently on OSX, for getting the docs working / built and its quite impossible to install if the docs aren't fully built i've bolded below an except how do i fix this please help me :) many thanks. *Extension error:*

RE: Can't typeset docs

2018-02-08 Thread Ben Gamari
| > Simon > | > > | I suspect the cause here is the --no-clean, which doesn't run ./boot > | and ./configure. The latter generates docs/users_guide/ghc_config.py, > | which appears to be missing. Is the problem reproducible with a fresh > | validate? > > Th

RE: Can't typeset docs

2018-02-07 Thread Simon Peyton Jones via ghc-devs
;t run ./boot | and ./configure. The latter generates docs/users_guide/ghc_config.py, | which appears to be missing. Is the problem reproducible with a fresh | validate? Thanks Ben. I think you are right -- sorry about that. I didn't know that you need to start from clean of you change

Re: Can't typeset docs

2018-02-06 Thread Ben Gamari
hich doesn't run ./boot and ./configure. The latter generates docs/users_guide/ghc_config.py, which appears to be missing. Is the problem reproducible with a fresh validate? Cheers, - Ben signature.asc Description: PGP signature ___ ghc-devs mailin

Can't typeset docs

2018-02-06 Thread Simon Peyton Jones via ghc-devs
nt-directory -f ghc.mk phase=1 phase_1_builds make[1]: Nothing to be done for 'phase_1_builds'. ===--- building final phase make --no-print-directory -f ghc.mk phase=final all /usr/bin/sphinx-build -b html -d docs/users_guide/.doctrees-html -D latex_paper_size=letter docs/users_guide docs/user

Re: Building the docs, again

2017-11-01 Thread Iavor Diatchki
l was caused because I hadn't realized what happens when building the documentation is disabled, namely: 1. There are multiple places to check if the documentation is actually disabled 2. When the documentation is disabled, the build targets disappear, rather than change their behavior to

Re: Building the docs, again

2017-11-01 Thread Patrick Dougherty
I spent some time with the docs this summer, and wrote a fair bit of the Hadrian documentation building code. So maybe I can shed some light. The question is which docs do you want to build? The library documentation relies on the haddock executable, which is one of the last targets in the

RE: Building the docs, again

2017-11-01 Thread Andrey Mokhov
> Maybe Hadrian will help here? Hadrian can build documentation in various formats but the current implementation is very coarse-grain: we either build all possible docs or no docs at all. It would be relatively easy to add more fine-grain documentation targets and modes. If someone co

RE: Building the docs, again

2017-11-01 Thread Simon Peyton Jones via ghc-devs
end to inform me that it doesn't know what is `html`. Maybe Hadrian will help here? Simon From: ghc-devs [mailto:ghc-devs-boun...@haskell.org] On Behalf Of Iavor Diatchki Sent: 31 October 2017 21:49 To: ghc-devs@haskell.org Subject: Re: Building the docs, again Hello, never mind, I figur

Re: Building the docs, again

2017-10-31 Thread Iavor Diatchki
is possible to build just the GHC docs, > without building the compiler. I was told to just run `make html`. This > does not appear to work, the command seems to just start building GHC. > What am I doing wrong? > > Here is the output I see, running the command from the root of the GH

Building the docs, again

2017-10-31 Thread Iavor Diatchki
Hello, sometime ago, I asked if it is possible to build just the GHC docs, without building the compiler. I was told to just run `make html`. This does not appear to work, the command seems to just start building GHC. What am I doing wrong? Here is the output I see, running the command from

Re: Can't build docs

2017-10-23 Thread Ben Gamari
Simon Peyton Jones via ghc-devs writes: > On Linux I can't build the docs. Log below > Simon > [snip] > processing users_guide.tex... index license intro 8.2.1-notes 8.4.1-notes > ghci runghc usage using using-warnings using-optimisation > Exception occurred: >

Can't build docs

2017-10-23 Thread Simon Peyton Jones via ghc-devs
On Linux I can't build the docs. Log below Simon "inplace/bin/ghc-stage1" -this-unit-id rts -shared -dynamic -dynload deploy -no-auto-link-packages -Lrts/dist/build -lffi -optl-Wl,-rpath -optl-Wl,'$ORIGIN' -optl-Wl,-zorigin `cat rts/dist/libs.depend` rts/dist/build/

RE: Docs

2017-08-22 Thread Simon Peyton Jones via ghc-devs
sphinx-build --version Sphinx v1.1.3 | -Original Message- | From: Ben Gamari [mailto:b...@smart-cactus.org] | Sent: 22 August 2017 14:55 | To: Simon Peyton Jones ; ghc-devs | Subject: Re: Docs | | Simon Peyton Jones via ghc-devs writes: | | > Ben et al | > I’m gettin

Re: Docs

2017-08-22 Thread Ben Gamari
Simon Peyton Jones via ghc-devs writes: > Ben et al > I’m getting this on Linux when making documentation. I have not > modified any of this documentation. Any ideas? Strangely I'm not able to reproduce any of these. Do these cause the build to fail? What does sphinx-build --version say? Cheer

Docs

2017-08-22 Thread Simon Peyton Jones via ghc-devs
%] win32-dlls /5playpen/simonpj/HEAD-1/docs/users_guide/editing-guide.rst:398: ERROR: Error in "ghci-cmd" directive: invalid option block. .. ghci-cmd:: :module; [*]⟨file⟩ :noindex: Load a module /5playpen/simonpj/HEAD-1/docs/users_guide/ghci.rst:496: ERROR: Error in

Fixing anchors in GHC docs

2015-04-28 Thread Eric Crockett
I think I sent this out already, but never heard back. An issue was fixed in HsColour regarding HTML anchors in the GHC docs, documented here: https://github.com/haskell/hackage-server/issues/319 Apparently GHC devs upload their own documentation [to hackage], which means HsColour needs to be

Re: GHC 7.10.1 html docs all flat?

2015-04-02 Thread Austin Seipp
n the website is just so people can browse it (and FWIW, the 'correct links' are there, but obviously the hyperlinks *to* the proper places are broken...) On Tue, Mar 31, 2015 at 1:20 PM, Randy Polen wrote: > The HP build expects that the html docs for the ghc-bundled packages will be &

Re: GHC 7.10.1 html docs all flat?

2015-03-31 Thread Sven Panne
2015-03-31 20:20 GMT+02:00 Randy Polen : > [...] Just want to make sure this is what is expected, and then change the HP > build code accordingly. [...] Hmmm, unless there is a strong reason to change this into a flat layout, I would propose to keep the docs hierarchical. I could envision c

GHC 7.10.1 html docs all flat?

2015-03-31 Thread Randy Polen
The HP build expects that the html docs for the ghc-bundled packages will be in heirarchical directories, based on the package name (e.g., GHC.Magic docs in libraries/ghc-prim-0.3.1.0/GHC-Magic.html) which is how it has been for many ghc releases. In 7.10.1, I thought it was an error but it seems

Re: Docs of the daily builds broken

2015-02-24 Thread Páli Gábor János
Hi there, 2015-02-24 9:32 GMT+01:00 Joachim Breitner : > while the index at > http://haskell.inf.elte.hu/docs/7.11.20150222.noWin32/html/libraries/index.html > exists, navigating to > http://haskell.inf.elte.hu/docs/7.11.20150222.noWin32/html/libraries/Data-Char.html > yie

Docs of the daily builds broken

2015-02-24 Thread Joachim Breitner
Hi, while the index at http://haskell.inf.elte.hu/docs/7.11.20150222.noWin32/html/libraries/index.html exists, navigating to http://haskell.inf.elte.hu/docs/7.11.20150222.noWin32/html/libraries/Data-Char.html yields a 404 error. Same for http://haskell.inf.elte.hu/docs/latest/html/libraries/Data

New docs about tracking down regressions in GHC

2014-08-07 Thread Edward Z . Yang
I recently spent some time debugging a performance regression in Haddock, and came up with some useful tips and tricks for tracking these things down in GHC. I wrote them up here: https://ghc.haskell.org/trac/ghc/wiki/Debugging/ProfilingGhc Please take a look. Thanks, Edward ___

The build is broken: docs/users_guide/users_guide.xml

2014-07-31 Thread Páli Gábor János
Hi there, I have dblatex installed on my builders that makes them failing for the last few days, e.g. [1]. The cause of the failure is this: "/usr/local/bin/dblatex" -P 'filename.as.url=0' docs/users_guide/users_guide.xml --ps -o docs/users_guide/users_guide.ps [..] Build

RE: Updated wiki docs in Type representation.

2013-06-07 Thread Simon Peyton-Jones
Thanks. I've checked and update a bit | -Original Message- | From: ghc-devs-boun...@haskell.org [mailto:ghc-devs-boun...@haskell.org] | On Behalf Of Erik de Castro Lopo | Sent: 07 June 2013 11:15 | To: ghc-devs@haskell.org | Subject: Updated wiki docs in Type representation. | | H

Updated wiki docs in Type representation.

2013-06-07 Thread Erik de Castro Lopo
Hi all, I was reading the GHC compiler commentary and the current GHC sources and found that description here: http://hackage.haskell.org/trac/ghc/wiki/Commentary/Compiler/TypeType#TherepresentationofType did not match the code in Git. I edited the wiki to the best of my ability bu

online docs for GHC head seem to be stale

2013-02-24 Thread Carter Schonwald
Hey All, I've been looking around in the documentation online for the current ghc head, and it looks to lack any information on the new SIMD ops. then i noticed the time stamp: http://www.haskell.org/ghc/dist/current/docs/html/libraries/ so those docs are from December? Whats needed to be