X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=doc%2Fclam_manual%2Fclam_docs.html;h=6872a4e19a6173f5a3ae9aae20e4b07d96d98c21;hb=8aec25f6496659248d997e474195ee4acdcdb976;hp=cce1f29288bfa9016ffbda98a748d3cedaf906b8;hpb=b4b77f8dda5d32d43c0a1dd66f9a165b64cacb09;p=feisty_meow.git diff --git a/doc/clam_manual/clam_docs.html b/doc/clam_manual/clam_docs.html index cce1f292..6872a4e1 100644 --- a/doc/clam_manual/clam_docs.html +++ b/doc/clam_manual/clam_docs.html @@ -165,9 +165,11 @@
    + +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_SCRIPTS directory in a folder named clam.
    @@ -295,7 +297,7 @@
      -
    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. @@ -365,12 +367,12 @@
    3. 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.
      4. -
    4. See the HOOPLE website for more details about +
    5. See the Feisty Meow Concerns Ltdwebsite for more details about downloading that codebase (http://feistymeow.org).
      6. @@ -600,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 @@ -644,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:

        @@ -661,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 @@ -673,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 @@ -867,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 @@ -983,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 @@ -1132,7 +1143,7 @@ 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 @@ -1171,7 +1182,7 @@ Instead, a generated variable called ACTUAL_TARGETS is used.
       -

      TARGETS_DIR

      +

      TARGETS_STORE

           This folder is where all generated files are to @@ -1712,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 @@ -2285,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.