Building GHC API Documentation?

Hello, I am trying to create my first patch, for #9294, where I want to export some extra things from Parser along with a bit of documentation. However, I cannot figure out how to regenerate the documentation for the GHC API (not for the libraries). I tried running `make html stage=0 FAST=YES` in `./compiler`, and got the following helpful message: make[2]: *** No rule to make target `html_compiler'. Stop. make[1]: *** [html_compiler] Error 2 make: *** [html] Error 2 So I'm a bit stumped. How do I regenerate Haddock documentation for the GHC API? Thanks! Andrew

Any suggestions? I'm still stuck on this, and don't really know what to try next. Andrew On Thu, Jul 10, 2014 at 9:36 PM, Andrew Gibiansky < andrew.gibiansky@gmail.com> wrote:
Hello,
I am trying to create my first patch, for #9294, where I want to export some extra things from Parser along with a bit of documentation. However, I cannot figure out how to regenerate the documentation for the GHC API (not for the libraries).
I tried running `make html stage=0 FAST=YES` in `./compiler`, and got the following helpful message:
make[2]: *** No rule to make target `html_compiler'. Stop. make[1]: *** [html_compiler] Error 2 make: *** [html] Error 2
So I'm a bit stumped. How do I regenerate Haddock documentation for the GHC API?
Thanks! Andrew

if you wanna resuse the same source tree, the heavy hammer for doing a rebuild is make maintainer-clean ; make maintainer-clean wipes alll build artifacts so its a clean tree, so everything will be built from scratch there might be a better way, but that sledgehammer should work On Mon, Jul 14, 2014 at 10:50 PM, Andrew Gibiansky < andrew.gibiansky@gmail.com> wrote:
Any suggestions? I'm still stuck on this, and don't really know what to try next.
Andrew
On Thu, Jul 10, 2014 at 9:36 PM, Andrew Gibiansky < andrew.gibiansky@gmail.com> wrote:
Hello,
I am trying to create my first patch, for #9294, where I want to export some extra things from Parser along with a bit of documentation. However, I cannot figure out how to regenerate the documentation for the GHC API (not for the libraries).
I tried running `make html stage=0 FAST=YES` in `./compiler`, and got the following helpful message:
make[2]: *** No rule to make target `html_compiler'. Stop. make[1]: *** [html_compiler] Error 2 make: *** [html] Error 2
So I'm a bit stumped. How do I regenerate Haddock documentation for the GHC API?
Thanks! Andrew
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://www.haskell.org/mailman/listinfo/ghc-devs

wooops, would need to be make maintainer-clean ; perl boot ; ./configure ; make On Mon, Jul 14, 2014 at 11:07 PM, Carter Schonwald < carter.schonwald@gmail.com> wrote:
if you wanna resuse the same source tree, the heavy hammer for doing a rebuild is
make maintainer-clean ; make
maintainer-clean wipes alll build artifacts so its a clean tree, so everything will be built from scratch
there might be a better way, but that sledgehammer should work
On Mon, Jul 14, 2014 at 10:50 PM, Andrew Gibiansky < andrew.gibiansky@gmail.com> wrote:
Any suggestions? I'm still stuck on this, and don't really know what to try next.
Andrew
On Thu, Jul 10, 2014 at 9:36 PM, Andrew Gibiansky < andrew.gibiansky@gmail.com> wrote:
Hello,
I am trying to create my first patch, for #9294, where I want to export some extra things from Parser along with a bit of documentation. However, I cannot figure out how to regenerate the documentation for the GHC API (not for the libraries).
I tried running `make html stage=0 FAST=YES` in `./compiler`, and got the following helpful message:
make[2]: *** No rule to make target `html_compiler'. Stop. make[1]: *** [html_compiler] Error 2 make: *** [html] Error 2
So I'm a bit stumped. How do I regenerate Haddock documentation for the GHC API?
Thanks! Andrew
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://www.haskell.org/mailman/listinfo/ghc-devs

I've discovered that passing options to `make` doesn't necessarily work all that well. Certain ones work great, but it's not as reliable as I might like.
That said, have you tried running the command in the ./ghc subdirectory? (Not the top directory -- it's probably ...../ghc/ghc on your machine.)
If you get that error on a clean checkout, you could perhaps post a bug report.
Richard
On Jul 14, 2014, at 10:50 PM, Andrew Gibiansky
Any suggestions? I'm still stuck on this, and don't really know what to try next.
Andrew
On Thu, Jul 10, 2014 at 9:36 PM, Andrew Gibiansky
wrote: Hello, I am trying to create my first patch, for #9294, where I want to export some extra things from Parser along with a bit of documentation. However, I cannot figure out how to regenerate the documentation for the GHC API (not for the libraries).
I tried running `make html stage=0 FAST=YES` in `./compiler`, and got the following helpful message:
make[2]: *** No rule to make target `html_compiler'. Stop. make[1]: *** [html_compiler] Error 2 make: *** [html] Error 2
So I'm a bit stumped. How do I regenerate Haddock documentation for the GHC API?
Thanks! Andrew
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://www.haskell.org/mailman/listinfo/ghc-devs

I did try that. I've found that if I run `make` in the toplevel, I can just
look at the last command it executes (which is generating all the
documentation) and copy/paste all of the huge command to rerun it. It's a
terrible solution but works well for me...
If you run it from the `ghc` subdirectory, you just get the same error
message but with "No rule to make target `html_ghc'. Stop".
Anyway, I've temporarily solved this by copying the huge raw command that
toplevel `make` produces to build the docs, but I don't know what the right
way to do this is.
-- Andrew
On Tue, Jul 15, 2014 at 4:36 AM, Richard Eisenberg
I've discovered that passing options to `make` doesn't necessarily work all that well. Certain ones work great, but it's not as reliable as I might like.
That said, have you tried running the command in the ./ghc subdirectory? (Not the top directory -- it's probably ...../ghc/ghc on your machine.)
If you get that error on a clean checkout, you could perhaps post a bug report.
Richard
On Jul 14, 2014, at 10:50 PM, Andrew Gibiansky
wrote: Any suggestions? I'm still stuck on this, and don't really know what to try next.
Andrew
On Thu, Jul 10, 2014 at 9:36 PM, Andrew Gibiansky < andrew.gibiansky@gmail.com> wrote:
Hello,
I am trying to create my first patch, for #9294, where I want to export some extra things from Parser along with a bit of documentation. However, I cannot figure out how to regenerate the documentation for the GHC API (not for the libraries).
I tried running `make html stage=0 FAST=YES` in `./compiler`, and got the following helpful message:
make[2]: *** No rule to make target `html_compiler'. Stop. make[1]: *** [html_compiler] Error 2 make: *** [html] Error 2
So I'm a bit stumped. How do I regenerate Haddock documentation for the GHC API?
Thanks! Andrew
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://www.haskell.org/mailman/listinfo/ghc-devs
participants (3)
-
Andrew Gibiansky
-
Carter Schonwald
-
Richard Eisenberg