X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fclam_manual%2Fclam_docs.html;h=6872a4e19a6173f5a3ae9aae20e4b07d96d98c21;hb=8aec25f6496659248d997e474195ee4acdcdb976;hp=8e862d22c8e8111fe49475c59f05b370f7cbb113;hpb=102061cab065f647954f3e935f11f433e2f088d4;p=feisty_meow.git diff --git a/doc/clam_manual/clam_docs.html b/doc/clam_manual/clam_docs.html index 8e862d22..6872a4e1 100644 --- a/doc/clam_manual/clam_docs.html +++ b/doc/clam_manual/clam_docs.html @@ -139,7 +139,7 @@ that need to be used with CLAM.  Several example makefiles and the full reference manual for CLAM are also included.
-     CLAM is part of the HOOPLE libraries (http://hoople.org/) +     CLAM is part of the Feisty Meow® codebase (http://feistymeow.org/) and can be downloaded from there or through a sourceforge mirror site.
    In the remainder of the document, we will often @@ -161,26 +161,23 @@
  • Setting environment variables for clam:
      • -
    1. FEISTY_MEOW_DIR:
      2. +
    2. FEISTY_MEOW_APEX:
        3. + +DEPRECATED
      1. **REVISE** out of date... This variable has been needed since clam became - part of the YETIcode project (at http://yeticode.org).
        2. + part of the YETIcode project (at http://feistymeow.org). -
      2. The default location for clam is under the FEISTY_MEOW_DIR - in a - folder named clam, although the version of clam shipped with the - HOOPLE - code (http://hoople.org) actually lives under the root of the - hoople - hierarchy.
        +
      3. The default location for clam is under the FEISTY_MEOW_SCRIPTS directory in a + folder named clam.
      4. If the yeti root directory is in $HOME/yeti already, then the - default for FEISTY_MEOW_DIR will work and it doesn't need to be + default for FEISTY_MEOW_APEX will work and it doesn't need to be declared.
      5. Setting the variable:
        6. @@ -220,10 +217,10 @@
        1. On Unix (assuming bash as shell): export - MAKEFLAGS="-I $FEISTY_MEOW_DIR/clam"
          2. + MAKEFLAGS="-I $FEISTY_MEOW_APEX/clam"
        2. On win32: set - MAKEFLAGS="-I %FEISTY_MEOW_DIR%/clam"
          3. + MAKEFLAGS="-I %FEISTY_MEOW_APEX%/clam"
        3. This variable also requires forward slashes instead of @@ -300,14 +297,14 @@
            -
          1. The hoople/bin directory in the archive has +
          2. The CLAM_BINARIES directory in the archive has pre-built versions of tools used by clam during a build.
          3. If you would rather rebuild them from source, then running - the script "bin/bootstrap_build.sh" will + the script "scripts/generator/produce_feisty_meow.sh" will recreate all of these internal tools.
            4. @@ -370,13 +367,13 @@
          4. The standard source code repository is a directory called - "hoople" - in the user's home directory.  If you decompress the hoople + "feisty_meow" + in the user's home directory.  If you decompress the feisty_meow library archive in your home directory, you should be all set to perform a build.
            5. -
          5. See the HOOPLE website for more details about - downloading that codebase (http://hoople.org).
            +
          6. See the Feisty Meow Concerns Ltdwebsite for more details about + downloading that codebase (http://feistymeow.org).
              7. @@ -605,13 +602,13 @@

              Important Variables

                   The clam root directory is pointed to by an internal variable called - "CLAM_DIR", + "CLAM_SCRIPTS", defined in $/variables.def.  This variable is used by the clam system to find extra files that might be needed by derived makefile support.  It is important to change this to the appropriate value when you are - using the system in a different location.  The CLAM_DIR variable + using the system in a different location.  The CLAM_SCRIPTS variable can either be directly edited in $/variables.def, or it can be overridden in the environment @@ -649,7 +646,7 @@ are generated.  All files generated by compilation are stored in the repository - directory (by default, either "~/hoople" in Linux or "l:\" in + directory (by default, either "~/feisty_meow" in Linux or "l:\" in win32).  There are three TYPEs supported so far:

                @@ -666,10 +663,15 @@ programs.
              -      Projects of the "library" type will + +DEPRECATED + + +     Projects of the "library" type will be given an include directory named after the project, such as - "~/hoople/include/basis". + + "~/feisty_meow/include/basis".  The include directory is created as a copy of the headers in the project's directory .  Library projects will also have their final products @@ -678,12 +680,16 @@      Projects that are of type "application" will have their executables copied to the executable directory in the repository (such as - "~/hoople/exe").
              + "~/hoople/exe"). + +
                   The "test" type of project will be promoted to a subdirectory named after the PROJECT that resides under the test hierarchy in the repository (such as "~/hoople/tests/turbodog").               + +DEPRECATED

                   SOURCE is a list of files that are to be compiled @@ -872,7 +878,7 @@

              MIDL is also a provided macro; it executes the Microsoft IDL compiler.
              - $(HIDESH) $(CLAM_DIR)/postconditions.sh
              + $(HIDESH) $(CLAM_SCRIPTS)/postconditions.sh
              This runs a shell script that handles the end portion of a @@ -988,11 +994,11 @@ but this will trap errors it sees and play the build error CLAM_ERROR_SOUND.
               -

              CLAM_BINARY_DIR

              +

              CLAM_BINARIES

                   This is a folder where the helper binaries for the CLAM makefile system are located.
              -

              CLAM_DIR

              +

              CLAM_SCRIPTS

                   This variable points at the location where the  definitions and helper scripts are located.  The default is @@ -1131,13 +1137,13 @@ the project's temporary directories will be created based on this variable. -

              FEISTY_MEOW_DIR

              +

              FEISTY_MEOW_APEX

                   Specifies the root directory for compilation or other  building activities.   The repository is also where source code and final products of compilation reside, unless - the default is over-ridden (see TARGETS_DIR).
              + the default is over-ridden (see TARGETS_STORE).

              SH & SHELL

                   These variables both point at a @@ -1176,11 +1182,11 @@ Instead, a generated variable called ACTUAL_TARGETS is used.
               -

              TARGETS_DIR

              +

              TARGETS_STORE

                   This folder is where all generated files are to - be stored.  It is usually identical to FEISTY_MEOW_DIR but can be + be stored.  It is usually identical to FEISTY_MEOW_APEX but can be overridden when the targets should be stored elsewhere.
               @@ -1340,7 +1346,7 @@ command line.  For C++ compilation, this is usually an INI file stored in the - FEISTY_MEOW_DIR under the build folder.  + FEISTY_MEOW_APEX under the build folder.  Here is a sample parameter file:
              #\
              @@ -1717,12 +1723,14 @@ for C++ header files (files ending in ?.h?).

              HOOPLE_HEADERS

              +DEPRECATED      The two standard places to look for headers (the repository and the third party directory) are listed in this variable.

              HOOPLE_LIBRARIES

              +DEPRECATED      This is where our libraries are located.  It is usually a subdirectory called "lib" under the repository @@ -2162,7 +2170,7 @@ time_sta.cpp
              TARGETS = mechanisms.dll
              LOCAL_LIBS_USED = basis
              - DEFINITIONS += BUILD_MECHANISMS USE_HOOPLE_DLLS

              + DEFINITIONS += BUILD_MECHANISMS USE_FEISTY_MEOW_DLLS

              include cpp/rules.def

              @@ -2290,7 +2298,7 @@      The most frequent cause of this problem is a directory - not being on your path.  The compilation tools bin (~/hoople/bin) + not being on your path.  The compilation tools bin (CLAM_BINARIES) directory must be in the PATH variable.