On Mon, Dec 12, 2011 at 04:23:20AM +0100, Luca Barbato wrote:
> It is a slight extension of build_system.txt
End in a period.
Also, if you replace build_system.txt, your patch should delete it.
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -1,7 +1,8 @@
> MANPAGES = $(PROGS-yes:%=doc/%.1)
> PODPAGES = $(PROGS-yes:%=doc/%.pod)
> HTMLPAGES = $(PROGS-yes:%=doc/%.html) \
> - doc/developer.html \
> + doc/build_system.html \
> + doc/developer.html \
> doc/faq.html \
Ahem ...
> --- /dev/null
> +++ b/doc/build_system.texi
> @@ -0,0 +1,63 @@
> +The Libav build system is composed of a @command{bash} script,
> +@command{configure}, and a number of @command{make} scripts.
It is very much not bash, but POSIX shell. One could also argue if
Makefiles are really separate given that they are snippets that get
assembled into one big Makefile at runtime.
> +@command{configure} generates @code{config.mak}, @code{config.h}, and
> +the @command{pkg-config} files.
> +Then it is possible to build and install Libav by running @command{make}
End in a period.
> +@table @option
> +@item V
> +Disable the default terse mode, the full command issued by make and its
> +output will be shown on the screen.
> +@item DESTDIR
> +Destination directory for the install targets, useful to prepare packages
> +or install Libav in cross-environments.
> +@end table
> +
> +@section Makefile targets
> +
> +@table @option
> +@item all
> +Default target, builds all the libraries and the executables.
> +@item install
> +Install headers, libraries and programs.
> +@item examples
> +Build the basic examples
> +@item documentation
> +Generates the html documentation and the programs man pages
> +@item config
> +Rerun configure with the options previously given. Useful when
> +updating sources or developing new features.
> +@item clean
> +Default clean directive, removes object files and binaries
> +@item distclean
> +Removes everything generated by @command{configure} and @command{make}.
> +If using a @command{git} tree, @command{git clean -x -d -f} is a quicker
> +alternative.
> +@end table
Please consistently end in periods or don't capitalize if the
descriptions are not complete sentences.
You could add an entry for fate.
Diego
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
