Re: [boost] How to handle generated html files with modular-boost and GIT?

Subject: Re: [boost] How to handle generated html files with modular-boost and GIT?
From: Daniel James (dnljms_at_[hidden])
Date: 2014-06-20 11:58:39

On 20 June 2014 12:28, Paul A. Bristow <pbristow_at_[hidden]> wrote:
> I've started to proof-read Vladimir Batov's Boost.Convert library and correct a
> (very few) typos etc.
>
> I've had some troublesome experience with building docs with Boost.Math and this
> is similar (but much smaller).
>
> Can experienced GIT users suggest how better to handle the problem of generated
> files in the /html folder.
>
> I've provided below a log of what I've done after a single edit to a Quickbook
> file.
>
> As you will see, there are *new* files (with randomized filenames)
>
> html/boost/convert_id274115.html
>  html/boost/convert_id274279.html
>  html/boost/convert_id277698.html
>  html/boost/convert_id277857.html
>
> (and also my log file cv_20jun14_1135.log)
>
> And all the .html file have been modified.
>
> So what do I do?
>
> I'd hope just to be able to GIT commit  (but there will be added files so "git
> commit -a") and "git push".

This isn't a git specific problem, there was the same issue with
subversion. If you want to check in the documentation, then I think
the best thing to do is delete the html files before building, and
then use 'git add -A html' to add the new documentation ('-A' causes
'git add' to remove any missing files, in addition to adding new files
and changes).

Or if you'd rather, I could add 'convert' to the documentation build,
so that the generated documentation doesn't need to be checked in.

> And what about .log files - it seems very useful and reasonable to have them
> live in /doc but be ignored by  GIT?
>
> Could/Should there be a global entry in top level /modular-boost/.gitignore to
> exclude all .log files?

I think it would have to be in the submodule's .gitignore, I don't
think submodules use the main repo's .gitignore.