[PATCH 0 of 7] Build documentation using distutils - v4

[Dan Villiom Podlaski Christiansen]

On 1 Dec 2009, at 22:02, Pascal Quantin wrote:

> Hi,
> 
> please find below some comments from a Windows user.

Great!

> Le 01/12/2009 21:33, Dan Villiom Podlaski Christiansen a écrit :
>> 	Remove the `install_package_data' subclass of `install_data' and use
>> 	the `package_data' functionality provided by distutils instead. As
>> 	package data must be located within the package directory, the data
>> 	files are now generated in the build directory.
>> 
>> 	To simplify the functionality of this change, the top-level `doc'
>> 	and `templates' directories have been moved into the `mercurial'
>> 	package directory.
>> 	[29d52513a530] [install-package-data.diff]
>>   
> This patch will break the build of win32 installer. You should also update the contrib/win32/mercurial.iss Inno Setup script file to reflect the directory name change.

I just looked at that file, and to be honest, I'd rather not touch it. I have no idea what's going on, where it gets the files from, nor where they should go.

>> 2009-11-30  Dan Villiom Podlaski Christiansen<danchr at gmail.com>
>> 
>> 	* contrib/bash/hg, contrib/bash_completion, contrib/zsh/_hg,
>> 	contrib/zsh_completion, setup.py:
>> 	setup: install some useful data files.
>> 
>> 	The selection is somewhat arbitrary. In the case of the Zsh
>> 	completion file, it will not conflict with the builtin Zsh
>> 	completions: they are in a file named `_mercurial', not `_hg'.
>> 	[4a4fa19cd99d] [install-data.diff]
>>   
> Same thing here, the mercurial.iss script should be updated (and we could add the bash script also).

Again, I'd rather not do this, as I have little faith in my ability to get it right. Perhaps the TortioseHg developers would help with this?

(I did try to take Windows into consideration when writing these changes. However, I have very limited experience with the OS, so I don't know how to actually adapt my changes to it.)

>> 2009-11-30  Dan Villiom Podlaski Christiansen<danchr at gmail.com>
>> 
>> 	* setup.py:
>> 	setup: omit manual category in HTML documentation file names.
>> 
>> 	The manual category --- e.g. the `5' in hgrc.5 --- is not relevant
>> 	when generating the HTML documentation. This tiny change causes the
>> 	generated&  installed files to be named only e.g. `hgrc.html' rather
>> 	than `hgrc.5.html'.
>> 
>> 	Please note that this may require redirects on servers hosting the
>> 	documentation.
>> 	[fd584f300ac6] [install-no-html-category.diff]
>>   
> Same thing.

I just noticed that this patch breaks the links between the generated HTML files. I'm afraid it isn't ready for inclusion, yet.

--

Dan Villiom Podlaski Christiansen
danchr at gmail.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 1943 bytes
Desc: not available
URL: <http://selenic.com/pipermail/mercurial-devel/attachments/20091201/ce7774c3/attachment.bin>