Why Use the Autotools?...xviii Acknowledgments... xx I Wish You the Very Best... xx

Size: px

Start display at page:

Download "Why Use the Autotools?...xviii Acknowledgments... xx I Wish You the Very Best... xx"

Godwin O’Connor’
5 years ago
Views:

1 CONTENTS IN DETAIL FOREWORD by Ralf Wildenhues xv PREFACE xvii Why Use the?...xviii Acknowledgments... xx I Wish You the Very Best... xx INTRODUCTION xxi Who Should Read This Book... xxii How This Book Is Organized... xxii Conventions Used in This Book...xxiii Versions Used in This Book...xxiii 1 A BRIEF INTRODUCTION TO THE GNU AUTOTOOLS 1 Who Should Use the?... 2 When Should You Not Use the?... 2 Apple Platforms and Mac OS X... 3 The Choice of Language... 4 Generating Your Package Build System... 5 Autoconf... 6 autoconf... 7 autoreconf... 7 autoheader... 7 autoscan... 7 autoupdate... 7 ifnames... 8 autom4te... 8 Working Together... 8 Automake... 9 automake aclocal Libtool libtool libtoolize ltdl, the Libtool C API Building Your Package Running configure Running make Installing the Most Up-to-Date Summary... 18

2 2 UNDERSTANDING THE GNU CODING STANDARDS 19 Creating a New Project Directory Structure Project Structure Makefile Basics Commands and Rules Variables A Separate Shell for Each Command Variable Binding Rules in Detail Resources for Makefile Authors Creating a Source Distribution Archive Forcing a Rule to Run Leading Control Characters Automatically Testing a Distribution Unit Testing, Anyone? Installing Products Installation Choices Uninstalling a Package Testing Install and Uninstall The Filesystem Hierarchy Standard Supporting Standard Targets and Variables Standard Targets Standard Variables Adding Location Variables to Jupiter Getting Your Project into a Linux Distro Build vs. Installation Prefix Overrides User Variables Configuring Your Package Summary CONFIGURING YOUR PROJECT WITH AUTOCONF 57 Autoconf Configuration Scripts The Shortest configure.ac File Comparing M4 to the C Preprocessor The Nature of M4 Macros Executing autoconf Executing configure Executing config.status Adding Some Real Functionality Generating Files from Templates Adding VPATH Build Functionality Let s Take a Breather An Even Quicker Start with autoscan The Proverbial autogen.sh Script Updating Makefile.in Initialization and Package Information AC_PREREQ AC_INIT AC_CONFIG_SRCDIR x

3 The Instantiating Macros AC_CONFIG_HEADERS Using autoheader to Generate an Include File Template Back to Remote Builds for a Moment Summary MORE FUN WITH AUTOCONF: CONFIGURING USER OPTIONS 89 Substitutions and Definitions AC_SUBST AC_DEFINE Checking for Compilers Checking for Other Programs A Common Problem with Autoconf Checks for Libraries and Header Files Is It Right or Just Good Enough? Printing Messages Supporting Optional Features and Packages Coding Up the Feature Option Formatting Help Strings Checks for Type and Structure Definitions The AC_OUTPUT Macro Summary AUTOMATIC MAKEFILES WITH AUTOMAKE 119 Getting Down to Business Enabling Automake in configure.ac A Hidden Benefit: Automatic Dependency Tracking What s in a Makefile.am File? Analyzing Our New Build System Product List Variables Product Source Variables PLV and PSV Modifiers Unit Tests: Supporting make check Reducing Complexity with Convenience Libraries Product Option Variables Per-Makefile Option Variables Building the New Library What Goes into a Distribution? Maintainer Mode Cutting Through the Noise Summary xi

4 6 BUILDING LIBRARIES WITH LIBTOOL 145 The Benefits of Shared Libraries How Shared Libraries Work Dynamic Linking at Load Time Automatic Dynamic Linking at Runtime Manual Dynamic Linking at Runtime Using Libtool Abstracting the Build Process Abstraction at Runtime Installing Libtool Adding Shared Libraries to Jupiter Using the LTLIBRARIES Primary Public Include Directories Customizing Libtool with LT_INIT Options Reconfigure and Build So What Is PIC, Anyway? Fixing the Jupiter PIC Problem Summary LIBRARY INTERFACE VERSIONING AND RUNTIME DYNAMIC LINKING 171 System-Specific Versioning Linux and Solaris Library Versioning IBM AIX Library Versioning HP-UX/AT&T SVR4 Library Versioning The Libtool Library Versioning Scheme Library Versioning Is Interface Versioning When Library Versioning Just Isn t Enough Using libltdl Necessary Infrastructure Adding a Plug-In Interface Doing It the Old-Fashioned Way Converting to Libtool s ltdl Library Preloading Multiple Modules Checking It All Out Summary FLAIM: AN AUTOTOOLS EXAMPLE 195 What Is FLAIM? Why FLAIM? An Initial Look Getting Started Adding the configure.ac Files The Top-Level Makefile.am File The FLAIM Subprojects The FLAIM Toolkit configure.ac File The FLAIM Toolkit Makefile.am File xii

5 Designing the ftk/src/makefile.am File Moving On to the ftk/util Directory Designing the XFLAIM Build System The XFLAIM configure.ac File Creating the xflaim/src/makefile.am File Turning to the xflaim/util Directory Summary FLAIM PART II: PUSHING THE ENVELOPE 229 Building Java Sources Using the Java Support Using ac-archive Macros Canonical System Information The xflaim/java Directory Structure The xflaim/src/makefile.am File Building the JNI C++ Sources The Java Wrapper Classes and JNI Headers A Caveat About Using the JAVA Primary Building the C# Sources Manual Installation Cleaning Up Again Configuring Compiler Options Hooking Doxygen into the Build Process Adding Nonstandard Targets Summary USING THE M4 MACRO PROCESSOR WITH AUTOCONF 251 M4 Text Processing Defining Macros Macros with Arguments The Recursive Nature of M Quoting Rules Autoconf and M The Autoconf M4 Environment Writing Autoconf Macros Simple Text Replacement Documenting Your Macros M4 Conditionals Diagnosing Problems Summary A CATALOG OF TIPS AND REUSABLE SOLUTIONS FOR CREATING GREAT PROJECTS 271 Item 1: Keeping Private Details out of Public Interfaces Solutions in C Solutions in C xiii

6 Item 2: Implementing Recursive Extension Targets Item 3: Using a Repository Revision Number in a Package Version Item 4: Ensuring Your Distribution Packages Are Clean Item 5: Hacking Autoconf Macros Providing Library-Specific Autoconf Macros Item 6: Cross-Compiling Item 7: Emulating Autoconf Text Replacement Techniques Item 8: Using the ac-archive Project Item 9: Using pkg-config with Providing pkg-config Files for Your Library Projects Using pkg-config Files in configure.ac Item 10: Using Incremental Installation Techniques Item 11: Using Generated Source Code Using the BUILT_SOURCES Variable Dependency Management Built Sources Done Right Item 12: Disabling Undesirable Targets Item 13: Watch Those Tab Characters! Item 14: Packaging Choices Wrapping Up INDEX 313 xiv

AUTOTOOLS GNU AUTOCONF, AUTOMAKE, A N D LIBTOOL JOHN CALCOTE.

AUTOTOOLS GNU AUTOCONF, AUTOMAKE, A N D LIBTOOL JOHN CALCOTE. AUTOTOOLS A P R A C T I T I O N E R S G U I D E T O GNU AUTOCONF, AUTOMAKE, A N D LIBTOOL JOHN CALCOTE AUTOTOOLS AUTOTOOLS A Practitioner s Guide to GNU Autoconf, Automake, and Libtool by John Calcote