interleaved/detached commenting style

[Neil Mitchell]

Hi,

I uploaded ghc.txt and converted it to Hoogle format. The links don't
work since haskell.org is running an outdated Hoogle (something I hope
to have a chance to fix this weekend). You can search with:

http://haskell.org/hoogle/?hoogle=%2Bghc+fixed

If the GHC build system always built ghc.txt and uploaded it somewhere
on the web then I would change the default Hoogle scripts to generate
and search GHC and keep it up to date.

Thanks, Neil

On Thu, Apr 28, 2011 at 7:30 PM, Ranjit Jhala <jhala at cs.ucsd.edu> wrote:
> Hi all --
>
> I have put up ghc.hoo (built using hoogle-4.2.2) at:
>
>        http://goto.ucsd.edu/~rjhala/ghc.hoo
>
> This links to the ghc-7.0.2 documentation and is an
> absolutely wonderful way to peer into the innards of GHC!
>
> Ranjit.
>
>
>
> On Apr 28, 2011, at 11:23 AM, Neil Mitchell wrote:
>
>> Hi Ben,
>>
>> Have you thought about setting up a Hoogle instance for the GHC code
>> base? I know Ranjit (cc'd) has been using it to help him get to grips
>> with GHC, but I can imagine it's useful for all the newcomer GHC
>> developers. If someone sends me the haddock --hoogle text output I'm
>> happy to host it on haskell.org/hoogle
>>
>> Thanks, Neil
>>
>> On Wed, Apr 27, 2011 at 2:32 AM, Ben Lippmeier <benl at ouroborus.net> wrote:
>>>
>>> On 25/04/2011, at 12:54 PM, Adam Megacz wrote:
>>>>
>>>> "Edward Z. Yang" <ezyang at MIT.EDU> writes:
>>>>> The feeling I get is most of GHC HQ doesn't use Haddock to browse
>>>>> GHC... we go straight for the source (with maybe ctags/hasktags
>>>>> setup).
>>>>
>>>> Okay, perhaps this isn't the best use of my time.
>>>
>>> I use Haddock all the time, or at least try to. Thankyou for cleaning up the
>>> Haddock docs. Please continue to do so.
>>>
>>> GHC was started before Haddock existed, which is why many of the modules
>>> don't have docs. Having a well organised code base, with decent code
>>> documentation is the #1 thing that will help new people get into the
>>> project. Time put in documenting and cleaning up the source is never wasted.
>>> Haddock hyperlinks also serve as a navigational aid that isn't provided by
>>> the commentary.
>>>
>>> I've spent about two months full time so far just cleaning up and commenting
>>> the DPH libraries and vectoriser. On a daily basis I look at some piece of
>>> DPH or GHC code and don't know what it's for or what it does. Part of that
>>> is just the natural development process, but if there *were* pre-existing
>>> docs then my life would be significantly easier.
>>>
>>> Ben.
>>>
>>>
>>> _______________________________________________
>>> Cvs-ghc mailing list
>>> Cvs-ghc at haskell.org
>>> http://www.haskell.org/mailman/listinfo/cvs-ghc
>>>
>
>