Changeset 3133 for trunk/doc

Timestamp:

Nov 24, 2013, 2:06:28 AM (8 years ago)

Author:

Peter

Message:

yat-config: mention that YAT_CBLAS_LIB is overideable; doxygen docs: prefer quotation like 'this', remove trailing WS, and give an easy example using yat-config in Makefile with default rules.

File:

• trunk/doc/build_tool.doxygen (modified) (5 diffs)

trunk/doc/build_tool.doxygen

@@ -2 +2 @@
 //
 // Copyright (C) 2008 Jari Häkkinen, Peter Johansson
-// Copyright (C) 2009, 2010, 2011 Peter Johansson
+// Copyright (C) 2009, 2010, 2011, 2013 Peter Johansson
 //
 // This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -27 +27 @@
 The \c yat-config script provides information on the local version of
 the library. For instance the following command shows that yat was
-installed at prefix \c `/usr/local'
+installed at prefix \c '/usr/local'
 
-\verbatim 
+\verbatim
  #> yat-config --prefix
 /usr/local
@@ -48 +48 @@
 all: $(BIN)
 
-$(BIN): $(OBJECTS) 
+$(BIN): $(OBJECTS)
   $(CXX) $(LDFLAGS) $(OBJECTS) -o $(BIN) $(LIBS)
 
@@ -57 +57 @@
 \endverbatim
 
+or if you are using <a href="http://www.gnu.org/software/make/">GNU
+Make</a> and prefer using default rules, you can use \c yat-config with
+
+\verbatim
+CPPFLAGS = `yat-config --cppflags`
+CXXFLAGS = `yat-config --cxxflags`
+LDFLAGS = `yat-config --ldflags --libs`
+
+all: foo
+\endverbatim
+
 From yat 0.6 an alternative \c CBLAS library can be specified using \c
 YAT_CBLAS_LIB environment variable. By default the \c CBLAS library
 detected during configuration of yat is used.
 
-For further information on yat-config use \c `yat-config \c --help'
+For further information on yat-config use \c 'yat-config \c --help'
 
 \since New in yat 0.5
@@ -67 +78 @@
 \section macro Autoconf Macro
 
-For applications using autoconf there is a macro available in \c
-yat.m4. The macro can be called from your \c configure.ac:
+For applications using <a href="http://www.gnu.org/software/make/">GNU
+Autoconf</a> there is a macro available in \c yat.m4. The macro can be
+called from your \c configure.ac:
 
-\verbatim 
-YAT_CHECK_YAT([minimum-version=0.5], [action-if-found], [action-if-not-found]) 
+\verbatim
+YAT_CHECK_YAT([minimum-version=0.5], [action-if-found], [action-if-not-found])
 \endverbatim