[Bash-completion-devel] Generated HTML docs in git?

Freddy Vulto fvulto at gmail.com
Thu Nov 26 22:47:53 UTC 2009


Ville Skyttä <ville.skytta <at> iki.fi> writes:
> I'm not sure if I've asked this before, but why do we have the generated HTML 
> doc in git, and why is it in a such an oddly named dir ("html~")?

I think my idea was to show us (developers) the output of generated HTML
documentation, especially those not being able to run asciidoc.  I used
the tilde (~) in html~ to give a hint that the contents of this
directory are automatically generated and manual changes here will be
overwritten.

Drawback of this approach is the unnecessary space the HTML
documentation is taken in git.  Another drawback is that documentation
commits go unnoticed on the commit-mailing-list because they easily
exceed the auto-mail-on-commit size limit (was it 200K?), and on the
other hand are causing too much noise.

Since asciidoc source documentation is very readable after all, +1 to
remove the `doc/html~' dir from git.

Maybe we can program an auto-upload of generated HTML documentation to
the bash-completion website after modifications to asciidoc source files
(doc/*)?

Regards,

Freddy Vulto
http://fvue.nl





More information about the Bash-completion-devel mailing list