darcs patch: Allow referring to a specific section within a module ...

--=_
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable

Fri Nov 28 00:27:36 EET 2008  Roman Cheplyaka <[email protected]>
  * Allow referring to a specific section within a module in a module link
  Fixes #65

--=_
Content-Type: text/x-darcs-patch;
	name="allow-referring-to-a-specific-section-within-a-module-in-a-module-link.dpatch"
Content-Transfer-Encoding: quoted-printable
Content-Description: A darcs patch for your repository!


New patches:

[Allow referring to a specific section within a module in a module link
Roman Cheplyaka <[email protected]>**20081127222736
 Fixes #65
] hunk ./src/Haddock/Backends/Html.hs 1595
-  markupModule        =3D \m -> ppModule (mkModuleNoPackage m) "",
+  markupModule        =3D \m -> let (mod,ref) =3D break (=3D=3D'#') m in p=
pModule (mkModuleNoPackage mod) ref,

Context:

[Drop HsDocTy annotations, they mess up pretty printing and also have a bra=
cketing bug (#2584)
Neil Mitchell**20081127143811] =

[FIX #45: generate two anchors for each name
David Waern <[email protected]>**20081123171321
 =

 We generate two anchor tags for each name, one where we don't escape the n=
ame
 and one where we URI-encode it. This is for compatibility between IE and O=
pera.
 Test output is updated.
] =

[HADDOCK_DATA_DIR changed to haddock_datadir
David Waern <[email protected]>**20081123143331] =

[Update tests to account for version number bump
David Waern <[email protected]>**20081123143252] =

[Bump major version number due to .haddock file format change
David Waern <[email protected]>**20081116143550] =

[Store hidden modules in .haddock files
David Waern <[email protected]>**20081115225933
 =

 We store documentation for an entity in the 'InstalledInterface' of the
 definition site module, and never in the same structure for a module which
 re-exports the entity. So when a client of the Haddock library wants to lo=
ok up
 some documentation, he/she might need to access a hidden module. But we
 currently don't store hidden modules in the .haddock files.
 =

 So we add the hidden modules and the Haddock options to the .haddock files=
.
 The options will be used to filter the module list to obtain the visible
 modules only, which is necessary for generating the contents and index for
 installed packages.
] =

[Update tests
David Waern <[email protected]>**20081115225845
 =

 For unknown reasons, test output for Bug1 and Test has changed for the bet=
ter.
] =

[Reflect version bump in test suite
David Waern <[email protected]>**20081115225818] =

[Make DocName an instance of NamedThing
David Waern <[email protected]>**20081110012914] =

[Export H.DocName in the library
David Waern <[email protected]>**20081110012052] =

[Document the functions in H.DocName
David Waern <[email protected]>**20081110011918] =

[Export DocName in the library
David Waern <[email protected]>**20081110011857] =

[Add Haddock.GHC.Utils to other-modules in library
David Waern <[email protected]>**20081109231410] =

[Re-export NameCache and friends from Distribution.Haddock
David Waern <[email protected]>**20081109222700] =

[Set HscTarget to HscNothing instead of HscAsm
David Waern <[email protected]>**20081108134342
 =

 There used to be a bug in the GHC API that prevented us from setting this
 value.
] =

[Fix warnings in H.GHC.Typecheck
David Waern <[email protected]>**20081106215945] =

[Fix warnings in H.InterfaceFile and H.Options
David Waern <[email protected]>**20081106215131] =

[Fix warnings in Haddock.Version
David Waern <[email protected]>**20081106214752] =

[Fix warnings in Haddock.ModuleTree
David Waern <[email protected]>**20081106214712] =

[Fix warnings in H.B.HH and H.B.HH2
David Waern <[email protected]>**20081106214653] =

[Depend on base 4.0.* instead of 4.*
David Waern <[email protected]>**20081106212633] =

[Bump version to 2.4.1 and update CHANGES
David Waern <[email protected]>**20081106211340] =

[Depend on base 4.* when using GHC >=3D 6.9, otherwise 3.*
David Waern <[email protected]>**20081106210748] =

[Wibble
David Waern <[email protected]>**20081105231830] =

[Update ANNOUNCE
David Waern <[email protected]>**20081105231535] =

[Add ANNOUNCE message
David Waern <[email protected]>**20081105224537] =

[Output version info before running tests
David Waern <[email protected]>**20081104235741] =

[Remove .ref files from tests/output/
David Waern <[email protected]>**20081104235521] =

[Update CHANGES
David Waern <[email protected]>**20081104234446] =

[Bump version number
David Waern <[email protected]>**20081104233743] =

[Update CHANGES
David Waern <[email protected]>**20081104233526] =

[Follow change to ExportDecl in frames code
David Waern <[email protected]>**20081104232017] =

[Enable framed view of the HTML documentation.
Thomas Schilling <[email protected]>**20081024170408
 =

 This patch introduces:
 =

  - A page that displays the documentation in a framed view.  The left
    side will show a full module index.  Clicking a module name will
    show it in the right frame.  If Javascript is enabled, the left
    side is split again to show the modules at the top and a very short
    synopsis for the module currently displayed on the right.
 =

  - Code to generate the mini-synopsis for each module and the mini
    module index ("index-frames.html").
 =

  - CSS rules for the mini-synopsis.
 =

  - A very small amount of javascript to update the mini-synopsis (but
    only if inside a frame.)
 =

 Some perhaps controversial things:
 =

  - Sharing code was very difficult, so there is a small amount of code
    duplication.
 =

  - The amount of generated pages has been doubled, since every module
    now also gets a mini-synopsis.  The overhead should not be too
    much, but I haven't checked.  Alternatively, the mini-synopsis
    could also be generated using Javascript if we properly annotate
    the actual synopsis.
] =

[TAG 2.3.0
David Waern <[email protected]>**20081104213026] =

[Add tests/TH.hs
David Waern <[email protected]>**20081104211344] =

[Add failing test for template haskell crash
David Waern <[email protected]>**20081103112504] =

[Update CHANGES
[email protected]**20081102224419] =

[Add HCAR entry
David Waern <[email protected]>**20081102222110] =

[Make named doc comments into ExportDoc instead of ExportDecl
David Waern <[email protected]>**20081027195904
 =

 Fixes a crash when processing modules without export lists containing name=
d
 docs.
] =

[Wibble
David Waern <[email protected]>**20081022213649] =

[Fix warnings in H.Utils
David Waern <[email protected]>**20081022213504] =

[Fix warnings in H.GHC.Utils
David Waern <[email protected]>**20081022211729] =

[Tidy up code in H.I.Create a little
David Waern <[email protected]>**20081022201146
 =

 Remove commented out half-done type instance support, and remove DeclWithD=
oc
 synonym.
] =

[Remove subordinate map and its usage
David Waern <[email protected]>**20081022200418
 =

 It is not needed now that we store subordinate names in the DeclInfo map.
] =

[Do not save hidden modules in the .haddock file (also for ghc >=3D 6.9)
David Waern <[email protected]>**20081021195452
 =

 When writing the first patch, I forgot to do the fix in both branches of a=
n #if
 macro.
] =

[Do not save hidden modules in the .haddock file
David Waern <[email protected]>**20081020211324
 =

 We were saving interfaces of all processed modules including those hidden =
using
 {-# OPTIONS_HADDOCK hide #-} in the .haddock file. This caused broken link=
s
 when generating the index for the libraries that come with GHC.
 =

 This patch excludes modules with hidden documentation when writing .haddoc=
k
 files. It should fix the above problem. =

] =

[TAG GHC 6.10 fork
Ian Lynagh <[email protected]>**20080919005443] =

[Make renamer consistent
David Waern <[email protected]>**20081020202550
 =

 Instead of explicitly making some binders Undocumented, treat all names th=
e
 same way (that is, try to find a Documented name).
] =

[Force interface more aggressively.
Thomas Schilling <[email protected]>**20081020111257
 =

 For running Haddock on GHC this reduces memory usage by about 50 MB on
 a 32 bit system.  A heap profile shows total memory usage peak at
 about 100 MB, but actual usage is at around 300 MB even with
 compacting GC (+RTS -c).
] =

[Document function and improve its layout
David Waern <[email protected]>**20081016220635] =

[Fix #61
David Waern <[email protected]>**20081016205842
 =

 We were not getting docs for re-exported class methods. This was because w=
e
 were looking up the docs in a map made from the declarations in the curren=
t
 module being rendered. Obviously, re-exported class methods come from anot=
her
 module.
 =

 Class methods and ATs were the only thing we were looking up using the doc=
 map,
 everything else we found in the ExporItems. So now I've put subordinate do=
cs
 in the ExportItem's directly, to make things a bit more consistent.
 =

 To do this, I added subordinates to the the declarations in the declaratio=
n
 map. This was easy since we were computing subordinates anyway, to store
 stand-alone in the map. I added a new type synonym 'DeclInfo', which is wh=
at we
 call what is now stored in the map. =

 =

 This little refactoring removes duplicate code to retrieve subordinates an=
d
 documentation from the HsGroup.
] =

[Wibble
David Waern <[email protected]>**20081016171847] =

[Add subordinates with docs to the declaration map
David Waern <[email protected]>**20081015221501
 =

 The only place in the code where we want the subordinates for a declaratio=
n is
 right after having looked up the declaration in the map.
 =

 And since we include subordinates in the map, we might as well take the
 opportunity to store those subordinates that belong to a particular declar=
ation
 together with that declaration.
 =

 We also store the documentation for each subordinate.
] =

[Add DeclInfo to H.Types
David Waern <[email protected]>**20081015221407] =

[Move convenient type synonym to H.Types
David Waern <[email protected]>**20081015215353] =

[Wibble
David Waern <[email protected]>**20081015214904] =

[Comment out unused type family stuff completely
David Waern <[email protected]>**20081015211217] =

[Use type synonyms for declarations and docs in H.I.Create
David Waern <[email protected]>**20081015210336] =

[Wibble
David Waern <[email protected]>**20081015204918] =

[Remove interface from LinksInfo
David Waern <[email protected]>**20081011140225
 =

 It was there to know the documentation home module when creating
 a wiki link, but we already know this since we have the DocName.
] =

[Compile with wrapper but remove it for dist-install
Clemens Fruhwirth <[email protected]>**20081010132936] =

[no need for handleErrMsg now, we don't throw any ErrMsgs
Simon Marlow <[email protected]>**20081010144304] =

[Update tests
David Waern <[email protected]>**20081010233405] =

[Add support for DocPic
David Waern <[email protected]>**20081010223549
 =

 The support for DocPic was merged into the GHC source long ago,
 but the support in Haddock was forgotten. Thanks Peter Gavin for
 submitting this fix!
] =

[Bump version number to 2.3.0
David Waern <[email protected]>**20081010214715] =

[Add back .haddock file versioning based on GHC version
David Waern <[email protected]>**20081010213459
 =

 It was accidentally removed in the patch for GHC 6.8.2 compatibility
] =

[Hide H.Utils in library
David Waern <[email protected]>**20081010212619] =

[Fix documentation for createInterfaces
David Waern <[email protected]>**20081010210809] =

[Make Haddock build with GHC 6.8.2
David Waern <[email protected]>**20081010203338] =

[Remove typecheckFiles and MonadUtils import from H.GHC.Typeccheck
David Waern <[email protected]>**20081010200231] =

[Add some strictness annotations in Interface
David Waern <[email protected]>**20081009235449
 =

 We add some strictness annotations to the fields of Interface,
 so that less GHC data is hold on to during processing.
] =

[Interleave typechecking with interface creation
David Waern <[email protected]>**20081009235354
 =

 At the same time, we fix a bug where the list of interfaces were
 processed in the wrong order, when building the links and renaming
 the interfaces.
] =

[Only load modules once when typechecking with GHC.
Thomas Schilling <[email protected]>**20081008122950
   =

 This still doesn't fix the memory leak since the typechecked source is
 retained and then processed separately.  To fix the leak, modules must
 be processed directly after typechecking.
] =

[TAG 2008-10-03
Ian Lynagh <[email protected]>**20081003155658] =

[Follow GHC API change of parseModule.
Thomas Schilling <[email protected]>**20081003104508] =

[Write a comment about source links for type instance declarations
David Waern <[email protected]>**20081002230458] =

[Remove ifaceEnv from Interface - it's no longer used
David Waern <[email protected]>**20081002225957] =

[For source links, get original module from declaration name instead of env=
ironment.
David Waern <[email protected]>**20081002225725
 =

 Getting it from the environment must have been a remnant from the
 times when we were using unqualified names (versions 0.x).
] =

[Add PatternSignatures LANGUAGE pragma to Main and Utils
David Waern <[email protected]>**20080924202421] =

[Fix building haddock when GhcProfiled=3DYES
Ian Lynagh <[email protected]>**20080928014235] =

[Do not wrap __ in brackets
Neil Mitchell**20080911145607] =

[Increase the GHC upper bound from 6.11 to 6.13
Ian Lynagh <[email protected]>**20080923180658] =

[Fix the in-tree haddock on Windows
Ian Lynagh <[email protected]>**20080921122016] =

[Fix paths used on Windows frmo a GHC tree: There is no whare directory
Ian Lynagh <[email protected]>**20080921111900] =

[TAG 6.10 branch has been forked
Ian Lynagh <[email protected]>**20080919123437] =

Patch bundle hash:
e864eb25490b0d1e9bea0295101013bb9109c01d

--=_
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
HaskellDoc mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/haskelldoc

--=_--

.