[libvirt] [PATCH 1/4] HACKING: Drop from the git repository

Andrea Bolognani abologna at redhat.com
Mon Jun 26 11:43:33 UTC 2017

On Mon, 2017-06-26 at 13:19 +0200, Peter Krempa wrote:
> > Despite being a generated file, HACKING has been tracked in
> > the git repository along with actual source files. As far as
> > I'm aware, it's the only generated file for which that happens.
>> > Times and times again, people[1] have committed changes to
> > the source file without refreshing the generated copy at the
> > same time.
>> > The rationale for tracking the generated file is to help out
> > people who just cloned the git repository looking to contribue;
> > however, README-hacking already contains enough information to
> > get perspective contributors to a place where they can simply
> > look at docs/hacking.html instead.
> NACK, there wouldn't be no sane way to look at the file without using a
> browser.

What's wrong with using a Web browser? If you don't want to
leave the terminal emulator, something like lynx will display
the HTML version very reasonably.

Most of our documentation, both for users and developers, is
in HTML format, including things like formatdomain.html which
I think we all need to refer to way more often than the
contributor guidelines.

> I'll stop objecting if it stays autogenerated after building the
> repository. I don't particulary care whether it is or isn't tracked in
> git.

I can look into that, but IIRC last time I tried I ended up
with a bunch of non-straightforward autotools incantation
and I think we can agree we have quite enough of those :)

Andrea Bolognani / Red Hat / Virtualization

More information about the libvir-list mailing list