Changes between Version 6 and Version 7 of pm-base-make


Ignore:
Timestamp:
Jun 15, 2006 3:54:02 PM (16 years ago)
Author:
lou
Comment:

Readability, typos

Legend:

Unmodified
Added
Removed
Modified
  • pm-base-make

    v6 v7  
    1919}}}
    2020
    21  * One should always start with a '''copyright note and author information''', and include the '''{{{svn:keyword}}} "{{{$Id}}}"'''.  The line with the keyword should start with "{{{##}}}" so that it is not copied into the generated {{{Makefile.in}}} file, which causes some confusion for subversion.
     21 * One should always start with a '''copyright note and author information''', and include the '''{{{svn:keyword}}}''' "'''{{{$Id}}}'''".  The line with the keyword should start with "{{{##}}}" so that it is not copied into the generated {{{Makefile.in}}} file, which causes some confusion for subversion.
    2222
    23  * The '''AUTOMAKE_OPTIONS''' variable is a special variable that indicates certain options for the {{{automake}}} run.  The '''foreign''' option doesn't require the strict conformance with GNU guidelines.
     23 * The '''AUTOMAKE_OPTIONS''' variable is a special variable that indicates certain options for the {{{automake}}} run.  The '''foreign''' option tells {{{automake}}} that it should not enforce strict conformance with GNU guidelines.
    2424
    25  * The '''EXTRA_DIST''' variable is set to every file that should be included in a {{{make dist}}} generated tarball.  One only needs to list non-source files, and non-autotools related files.  In the above example, this is only the configuration file for doxygen.
     25 * The '''EXTRA_DIST''' variable is set to every file that should be included in a tarball generated with {{{make dist}}}.  One only needs to list non-source files, and non-autotools related files.  In the above example, the only file in this category is the configuration file for doxygen.
    2626
    2727
     
    3636}}}
    3737
    38  * The {{{Makefile.am}}} in a package base directory needs to be told into which subdirectories to recurse.  This is done with the '''SUBDIRS''' variable.  The Autoconf output variable {{{subdirs}}} is already automatically set to the correct value by {{{configure}}}, based on the results of the {{{AC_COIN_MAIN_SUBDIRS}}} macro tests.
     38 * The {{{Makefile.am}}} in a package base directory needs to be told the subdirectories into which it should recurse.  This is done with the '''SUBDIRS''' variable.  The Autoconf output variable {{{subdirs}}} is already automatically set to the correct value by {{{configure}}}, based on the results of the {{{AC_COIN_MAIN_SUBDIRS}}} macro tests.
    3939
    4040{{{
     
    5858}}}
    5959
    60  * In this section we can define '''extra Makefile targets'''.  As you can see, the '''test''' (and '''unitTest''') targets first make sure that everything is compiled (the target {{{all}}} is the automatically generated target for compilation of everything).  Then it changes into the packages project directory and runs the {{{test}}} target there.  It is also nice to provide a '''tests''' (and '''unitTests''') target, which runs the {{{test}}} targets in every project subdirectory that seems to have a {{{test}}} subdirectory with a Makefile.
     60 * In this section we can define '''extra Makefile targets'''.  As you can see, the '''test''' (and '''unitTest''') targets first make sure that everything is compiled (the target {{{all}}} is the automatically generated target for compilation of everything).  Then it changes into the package's project directory and runs the {{{test}}} target there.  It is also nice to provide a '''tests''' (and '''unitTests''') target, which runs the {{{test}}} targets in every project subdirectory that seems to have a {{{test}}} subdirectory with a Makefile.
    6161
    6262
     
    6868}}}
    6969
    70  * For C++ packages, we usually also provide a target '''doxydoc''', which runs the {{{doxygen}}} program for all source code found in subdirectories.  Note the "'''cd $(srcdir)'''" here.  In case of a VPATH compilation, the Makefile generated from this {{{Makefile.am}}} file is not run in the directory where {{{doxygen}}} should be run.  The Autoconf output variable '''srcdir''' is set to the directory which contains the source code (such as the {{{Makefile.am}}} file) corresponding to the VPATH directory.
     70 * For C++ packages, we usually also provide a target '''doxydoc''', which runs the {{{doxygen}}} program for all source code found in subdirectories.  Note the "'''cd $(srcdir)'''" here.  In the case of a VPATH compilation, the Makefile generated from this {{{Makefile.am}}} file is not run in the directory where {{{doxygen}}} should be run.  The Autoconf output variable '''srcdir''' is set to the directory which contains the source code (such as the {{{Makefile.am}}} file) corresponding to the VPATH directory.
    7171
    7272{{{