Ticket #3532 (closed bug: fixed)

Opened 4 years ago

Last modified 4 years ago

haddock should support content indexing of versioned package dirs

Reported by: juhpetersen Owned by: igloo
Priority: high Milestone: 6.12.1
Component: Documentation Version: 6.10.4
Keywords: Cc: duncan
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Difficulty: Unknown
Test Case: Blocked By:
Blocking: Related Tickets:

Description

When generating the libraries/index.html file haddock generates broken urls to the documentation in versioned library doc directories.

It also means it is not possible to have documentation indexed for more than one version of a library.

To reproduce:

  • install mylibrary's docs in libraries/mylibrary-1.0.0.1
  • run gen_contents_index in libraries

Observe index.html links for mylibrary point to libraries/mylibrary/ not libraries/mylibrary-1.0.0.1/

Change History

follow-up: ↓ 2   Changed 4 years ago by juhpetersen

  • cc duncan added

Duncan, any comment on this in the context of ghc-6.10.4, packaging haskell-platform network docs, and:

cabal configure ... --htmldir=%{_docdir}/ghc/libraries/%{pkg_name}-%{version}
cabal build
cabal haddock
(install)

in reply to: ↑ 1   Changed 4 years ago by juhpetersen

cabal configure ... --htmldir=%{_docdir}/ghc/libraries/%{pkg_name}-%{version}

I mean

cabal configure ... --htmldir=/usr/share/doc/ghc/libraries/network-2.2.1.4

ie parallel install of networks documentation. But this also applies to versioned new documentation of new system packages.

  Changed 4 years ago by igloo

  • priority changed from normal to high
  • difficulty set to Unknown
  • milestone set to 6.12.1

  Changed 4 years ago by igloo

  • owner set to igloo

  Changed 4 years ago by igloo

  • status changed from new to closed
  • failure set to None/Unknown
  • resolution set to fixed

Fixed in HEAD and 6.12 by:

Sun Nov  8 21:07:01 GMT 2009  Ian Lynagh <igloo@earth.li>
  * Put docs into versioned directory names; fixes trac #3532
  You can now have multiple versions of a package installed, and
  gen_contents_index will do the right thing.

Tue Nov 10 22:36:32 GMT 2009  Ian Lynagh <igloo@earth.li>
  * Use relative paths for haddockHTMLs in the inplace package.conf
  This means that the docs get built with the correct relative paths.
  When installing, the absolute path will still be used.
Note: See TracTickets for help on using tickets.