Re: Git and Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 8/10/10 9:55 PM, Sultan Shakir wrote:
> Yes I guess I could.  I am a little new at this.   I got the same idea
> after watching Stephen Wood's video here:
> http://developer.yahoo.com/yui/theater/video.php?v=woods-yuiconf2009-yuidoc
> .  He had 3 rules/guidelines that might work if we use YUI Doc to
> generate the documentation:
> 
> 1) Generate documentation as part of the build
> 2) Don’t manually check documentation in to VCS (do it automatically)
> 3) Treat documentation comments like code
> 
> I am not sure how to make it run as part of my build process though.

Please don't top post.

If the documentation is generated as part of the build, then there is no
reason to have it part of the history - you can always rebuild it from
the source. For the same reason you don't put compiled source into git.

And how to generate the doc as part of the build? That's up to you and
very much depends on what build system you use.

tom

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]