Re: [Nasm-devel] Documentation source format

[Cyrill G. <gor...@gm...>]

On 12/19/2010 02:50 AM, Christian Masloch wrote:
> Hi list,

Hi Christian,

> 
> is there anything that I have to know for modifying the source of NASM's  
> documentation? For example, do I have to wrap lines somehow? I have used

As far as I know there is no restriction on long lines though better to have
whole doc/nasmdoc.src in common shape, ie all lines should be inside 80 column.
But this is of course not a strict and mandatory rule.

> Halibut before, which is the successor of the scripts used by NASM, so I  
> know how to format text there - I just don't know in what ways NASM's  
> format differs. I am also interested in the documentation build process;  

Have no idea about Halibut but I think nasm doc generator engine is not
changed much now, just try what you have been doing before with
Halibut and check if behaviour changed.

> is it carried out by the makefiles? By the supplied OpenWatcom makefiles  

It's carried by doc/Makefile and I think it's independent to target platform,
since it uses perl and a few other tools (see utils in Makefile itself).

> too? (For my local builds, building the text files would probably be  
> enough because I intend to send the patches here later. Just saying as I  
> recall that building some of the other documentation formats was more  
> difficult.)

I think docs are generated same way for all platforms. Though better to
CC hpa and Keith :)

> 
> Regards,
> Christian
> 
> P.S.: For those who don't know me, I'll introduce me: My name is Christian  
> Masloch. I'm a free software developer. Until recently I was only a user  
> of NASM. Cyrill asked me to help you out if I'm interested. I am  
> interested, so I'm working on some patches right now, mostly related to  
> the preprocessor. (Be assured that I'm not just hacking them together like  
> I did for the negative relocation suggestion.)
> 

Yes, I'm glad if there is an interest to join nasm-devel team :) Preprocessor
things are mostly carried by Keith so he is CC'ed.

-- 
    Cyrill