docs: hacking: Describe which order to look at directories.

When browsing the source code.
This commit is contained in:
Richard W.M. Jones
2016-06-06 15:50:27 +01:00
parent 613a7e0884
commit a3ca5182d4

View File

@@ -38,6 +38,16 @@ To build from source, first read the L<guestfs-building(1)>.
=head1 SOURCE CODE SUBDIRECTORIES
There are a lot of subdirectories in the source tree! Which ones
should you concentrate on first? F<src> and F<daemon> which contain
the source code of the core library. F<generator> is the code
generator described above, so that is important. The F<Makefile.am>
in the root directory will tell you in which order the subdirectories
get built. And then if you are looking at a particular tool
(eg. F<v2v>) or language binding (eg. F<python>), go straight to that
subdirectory, but remember that if you didn't run the generator yet,
then you may find files which appear to be missing.
=over 4
=item F<align>