BuildSystem: docs

- added blurb about troubleshooting and log files.
- regenerated doc/ txt files.


git-svn-id: svn://svn.handbrake.fr/HandBrake/trunk@2414 b64f7644-9d1e-0410-96f1-a4d463321fa5

5 files changed, 25 insertions, 23 deletions

diff --git a/doc/texi/Building.cygwin.texi b/doc/texi/Building.cygwin.texi
index 643a591ee..583755b9d 100644
--- a/doc/texi/Building.cygwin.texi
+++ b/doc/texi/Building.cygwin.texi
@@ -44,4 +44,5 @@ As of this writing, @value{OS.cygwin} has available to it several versions of gc
 
 @c %**-------------------------------------------------------------------------
 @include building/chapter.via.terminal.texi
+@include building/chapter.troubleshooting.texi
 @include building/appendix.repo.texi
diff --git a/doc/texi/Building.linux.texi b/doc/texi/Building.linux.texi
index 8a3f8da4a..f3b562896 100644
--- a/doc/texi/Building.linux.texi
+++ b/doc/texi/Building.linux.texi
@@ -103,4 +103,5 @@ gstreamer-devel gstreamer-plugins-base-devel
 
 @c %**-------------------------------------------------------------------------
 @include building/chapter.via.terminal.texi
+@include building/chapter.troubleshooting.texi
 @include building/appendix.repo.texi
diff --git a/doc/texi/Building.osx.texi b/doc/texi/Building.osx.texi
index 5ab1ff1ce..ee3f82619 100644
--- a/doc/texi/Building.osx.texi
+++ b/doc/texi/Building.osx.texi
@@ -20,10 +20,10 @@ Building on @value{OS.osx} is well supported. It is the reference platform for @
 
 @itemize @bullet
 @item Mac Intel hardware
-@item @value{OS.osx} 10.5.6
+@item @value{OS.osx} 10.5.7
 @item Xcode-3.1.2
 @item gcc 4.0.1 (Apple Inc. build 5490)
-@item yasm 0.7.2.2153 (for i386 and x86_64 architectures)
+@item yasm 0.8.0.2194 (for i386 and x86_64 architectures)
 @end itemize
 
 @include building/prerequisites.bundled.texi
@@ -67,4 +67,5 @@ UB.archs = i386 x86_64
 
 @c %**-------------------------------------------------------------------------
 @include building/chapter.via.xcode.texi
+@include building/chapter.troubleshooting.texi
 @include building/appendix.repo.texi
diff --git a/doc/texi/building/chapter.overview.texi b/doc/texi/building/chapter.overview.texi
deleted file mode 100644
index 29dec0394..000000000
--- a/doc/texi/building/chapter.overview.texi
+++ /dev/null
@@ -1,21 +0,0 @@
-@anchor{overview}
-@chapter Build Overview
-The build system has several
-
-This chapter is for building from a terminal/shell environment in as few commands as possible. If more flexibility is required you should skip this chapter and jump to @ref{process}.
-
-@example
[email protected]{}
-./configure --launch
-@end example
-
-The special option @command{--launch} selected launch mode and performs the following steps:
-
-@itemize
-@item assert scratch directory @file{build/} does not exist
-@item create scratch directory @file{build/}
-@item change to directory @file{build/}
-@item launch @command{make}
-@item capture build output to @file{build/log.txt}
-@item echo build output
-@end itemize
diff --git a/doc/texi/building/chapter.troubleshooting.texi b/doc/texi/building/chapter.troubleshooting.texi
new file mode 100644
index 000000000..4d42e76a3
--- /dev/null
+++ b/doc/texi/building/chapter.troubleshooting.texi
@@ -0,0 +1,20 @@
+@anchor{troubleshooting}
+@chapter Troubleshooting
+When troubleshooting build issues, the following files relative to the @file{build/} directory may be especially useful:
+
+@table @file
+@item GNUmakefile
+Top-level makefile which contains build settings generated via @b{configure}.
+
+@item log/config.info.txt
+Record of output from @b{configure}.
+
+@item log/config.verbose.txt
+Record of verbose output from @b{configure}.
+
+@item log/build.txt
+Record of output from @command{configure --launch}. Similar output may be recorded using @command{make} depending on which shell is in use, eg: @command{make >& log/build.txt} or @command{make > log/build.txt 2>&1}.
+
+@item log/xcodemake.env.txt
+Environment (variables) dump as seen when Xcode forks @command{make}. @value{OS.osx} only.
+@end table