summaryrefslogtreecommitdiffstats
path: root/doc/texi/building
diff options
context:
space:
mode:
authorkonablend <[email protected]>2009-03-04 21:28:47 +0000
committerkonablend <[email protected]>2009-03-04 21:28:47 +0000
commit3ca54dc4fdee70ca197cffc7015fa7317d75e380 (patch)
tree058d256e764db072e07299b6216db6920ae331b3 /doc/texi/building
parent103f4bb2dfe194dc7bee565fc981fcd8c5beed88 (diff)
BuildSystem:
- added new target: make report.help (for cvk_b). - updated doc accordingly. - updated doc QuickStart chapter to be clearer for novices. - added wiki auto-posting targets which are work-in-progress git-svn-id: svn://svn.handbrake.fr/HandBrake/trunk@2221 b64f7644-9d1e-0410-96f1-a4d463321fa5
Diffstat (limited to 'doc/texi/building')
-rw-r--r--doc/texi/building/chapter.quickstart.texi5
-rw-r--r--doc/texi/building/chapter.via.terminal.texi11
-rw-r--r--doc/texi/building/command.texi4
3 files changed, 16 insertions, 4 deletions
diff --git a/doc/texi/building/chapter.quickstart.texi b/doc/texi/building/chapter.quickstart.texi
index 7829087e4..9e18db756 100644
--- a/doc/texi/building/chapter.quickstart.texi
+++ b/doc/texi/building/chapter.quickstart.texi
@@ -1,13 +1,14 @@
@anchor{quickstart}
@chapter QuickStart
-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{overview}.
+This chapter is for building from a terminal/shell environment in as few commands as possible. Upon completion of the following commands you should have a fresh build of @value{HB.name}. Further instructions are available beginning with @ref{overview} which describes procedures suitable for repeating builds. This chapter should be skipped by those seeking more than a minimalist build.
@example
@COMMAND.checkout{}
./configure --launch
+cd build/
@end example
-The special option @command{--launch} selected launch mode and performs the following steps:
+The special option @command{--launch} selects launch mode and performs the following steps:
@itemize
@item assert scratch directory @file{build/} does not exist
diff --git a/doc/texi/building/chapter.via.terminal.texi b/doc/texi/building/chapter.via.terminal.texi
index 4f299f179..0c323ab8c 100644
--- a/doc/texi/building/chapter.via.terminal.texi
+++ b/doc/texi/building/chapter.via.terminal.texi
@@ -108,6 +108,15 @@ Clean all build output including contrib modules. Configuration is retained.
@item make doc
Build auto-generated project documentation. Various articles are produced and may be found in @file{build/doc/articles}.
+
+@item make report.help
+Print list of available makefile vars report targets.
+These reports detail var definitions and expanded values used by the build system.
+@b{For experts only}.
+
+@item make report.all
+Convenience target which aggregates all reports.
+@b{For experts only}.
@end table
@anchor{terminal.targets.general}
@@ -191,3 +200,5 @@ GCC.gcc = gcc-4.2
## replace optimize for 'speed' with more agressive settings
GCC.args.O.speed = -O3 -fomit-frame-pointer -msse4.2
@end example
+
+See also @command{make report.help} which displays a set of reports used to dump makefile vars.
diff --git a/doc/texi/building/command.texi b/doc/texi/building/command.texi
index 3acddc3a0..4c21e9892 100644
--- a/doc/texi/building/command.texi
+++ b/doc/texi/building/command.texi
@@ -1,4 +1,4 @@
@macro COMMAND.checkout{}
-svn checkout @value{HB.repo.url} @value{HB.acro.lower}-@value{HB.repo.branch}
-cd @value{HB.acro.lower}-@value{HB.repo.branch}
+svn checkout @value{HB.repo.url} @value{HB.acro.lower}@value{HB.repo.branch}
+cd @value{HB.acro.lower}@value{HB.repo.branch}
@end macro