Deploying to gh-pages from @ 56ff714 🚀

Author: rouson

README.md

@@ -19,7 +19,6 @@ This assertion utility contains four public entities:
 
 The `assert` subroutine
 * Error-terminates with a variable stop code when a caller-provided logical assertion fails,
-* Includes user-supplied diagnostic data in the output if provided by the calling procedure,
 * Is callable inside `pure` procedures, and
 * Can be eliminated at compile-time, as controlled by the `ASSERTIONS` preprocessor define.
 
@@ -42,10 +41,6 @@ If instead `fpm install` is used, then either the user must copy `include/assert
 the user must invoke `assert` directly (via `call assert(...)`).
 In the latter approach when the assertions are disabled, the `assert` procedure will start and end with `if (.false.) then ... end if`, which might facilitate automatic removal of `assert` during the dead-code removal phase of optimizing compilers.
 
-The `characterizable_t` type defines an `as_character()` deferred binding that produces `character` strings for use as diagnostic output from a user-defined derived type that extends  `characterizable_t` and implements the deferred binding.
-
-The `intrinsic_array_t` type that extends `characterizable_t` provides a convenient mechanism for producing diagnostic output from arrays of intrinsic type `complex`, `integer`, `logical`, or `real`.
-
 Use Cases
 ---------
 Two common use cases include
@@ -63,27 +58,49 @@ The requirements and assurances might be constraints of three kinds:
 
 The [example/README.md] file shows examples of writing constraints in notes on class diagrams using the formal syntax of the Object Constraint Language ([OCL]).
 
-Downloading, Building, and Running Examples
--------------------------------------------
+Running the Examples
+--------------------
+See the [./example](./example) subdirectory.
+
+Building and Testing
+--------------------
+
+- [Cray Compiler Environment (CCE) `ftn`](#cray-compiler-environment-cce-ftn)
+- [GNU Compiler Collection (GCC) `gfortran`](#gnu-compiler-collection-gcc-gfortran))
+- [Intel `ifx`](#intel-ifx))
+- [LFortran `lfortran`](#lfortran-lfortran)
+- [LLVM `flang-new`](#llvm-flang-new)
+- [Numerical Algorithms Group (NAG) `nagfor`](#numerical-algorithms-group-nag-nagfor)
+
+### Cray Compiler Environment (CCE) `ftn`
+Because `fpm` uses the compiler name to determine the compiler identity and because
+CCE provides one compiler wrapper, `ftn`, for invoking all compilers, you will
+need to invoke `ftn` in a shell script named to identify CCE compiler. For example,
+place a script named `crayftn.sh` in your path with the following contents and with
+executable privileges set appropriately:
+```
+#!/bin/bash
 
-### Downloading Assert
+ftn $@
 ```
-git clone git@github.com:berkeleylab/assert
-cd assert
+Then build and test Assert with the command
+```
+fpm test --compiler crayftn.sh --profile release
 ```
 
-### Building and testing with `gfortran`
+### GNU Compiler Collection (GCC) `gfortran`
+
 #### Single-image (serial) execution
-The command below builds Assert and runs the full test suite in a single image.
-For `gfortran` 14 or later, use
+With `gfortran` 14 or later, use
 ```
 fpm test --profile release
 ```
-For `gfortran` 13 or earlier, use
+With `gfortran` 13 or earlier, use
 ```
 fpm test --profile release --flag "-ffree-line-length-0"
 ```
 The above commands build the Assert library (with the default of assertion enforcement disabled) and runs the test suite.
+
 #### Multi-image (parallel) execution
 With `gfortran` 14 or later versions and OpenCoarrays installed, use
 ```
@@ -93,60 +110,56 @@ With `gfortran` 13 or earlier versions and OpenCoarrays installed,
 ```
 fpm test --compiler caf --profile release --runner "cafrun -n 2" --flag "-ffree-line-length-0"
 ```
-To build and test with the Numerical Algorithms Group (NAG) Fortran compiler version
-7.1 or later, use
-```
-fpm test --compiler=nagfor --profile release --flag "-coarray=cosmp -fpp -f2018"
-```
 
-### Building and testing with the Intel `ifx` compiler
+### Intel `ifx`
+
 #### Single-image (serial) execution
 ```
 fpm test --compiler ifx --profile release 
 ```
+
 #### Multi-image (parallel) execution 
 With Intel Fortran and Intel MPI installed,
 ```
 fpm test --compiler ifx --profile release --flag "-coarray -DASSERT_MULTI_IMAGE"
 ```
 
-### Building and testing with the LLVM `flang-new` compiler
-#### LLVM version 19
+### LLVM `flang-new`
+
+#### Single-image (serial) execution
+With `flang-new` version 19, use
 ```
 fpm test --compiler flang-new --flag "-mmlir -allow-assumed-rank -O3"
 ```
-#### LLVM version 20 or later
+With `flang-new` version 20 or later, use
 ```
 fpm test --compiler flang-new --flag "-O3"
 ```
 
-### Building and testing with the Numerical Algorithms Group (NAG) compiler
+### LFortran `lfortran`
+
+#### Single-image (serial) execution
 ```
-fpm test --compiler nagfor --profile release --flag "-fpp -coarray=cosmp"
+fpm test --compiler lfortran --profile release --flag --cpp
 ```
 
-### Building and testing with the Cray Compiler Environment (CCE)
-Because `fpm` uses the compiler name to determine the compiler identity and because
-CCE provides one compiler wrapper, `ftn`, for invoking all compilers, you will
-need to invoke `ftn` in a shell script named to identify CCE compiler. For example,
-place a script named `crayftn.sh` in your path with the following contents and with
-executable privileges set appropriately:
+### Numerical Algorithms Group (NAG) `nagfor`
+
+#### Single-image (serial) execution
+With `nagfor` version 7.1 or later, use
+```
+fpm test --compiler nagfor --flag -fpp
 ```
-#!/bin/bash
 
-ftn $@
+#### Multi-image execution
+With `nagfor` 7.1, use
 ```
-Then build and test Assert with the command
+fpm test --compiler nagfor --profile release --flag "-fpp -coarray=cosmp -f2018"
 ```
-fpm test --compiler crayftn.sh --profile release
+With `nagfor` 7.2 or later, use
+```
+fpm test --compiler nagfor --flag -fpp
 ```
-
-
-### Building and testing with other compilers
-To use Assert with other compilers, please submit an issue or pull request.  
-
-### Running the examples
-See the [./example](./example) subdirectory.
 
 Documentation
 -------------
@@ -208,19 +221,19 @@ character for line-breaks in a macro invocation:
 
 ```fortran
 ! OK for flang-new and gfortran
-call_assert_diagnose( computed_checksum == expected_checksum, \
-                      "Checksum mismatch failure!", \
-                      expected_checksum )                  
+call_assert_describe( computed_checksum == expected_checksum, \
+                      "Checksum mismatch failure!" \
+                    )                  
 ```
 
 Whereas Cray Fortran wants `&` line continuation characters, even inside
 a macro invocation:
 
 ```fortran
 ! OK for Cray Fortran
-call_assert_diagnose( computed_checksum == expected_checksum, &
-                      "Checksum mismatch failure!", &
-                      expected_checksum )                  
+call_assert_describe( computed_checksum == expected_checksum, &
+                      "Checksum mismatch failure!" &
+                    )                  
 ```
 
 There appears to be no syntax acceptable to all compilers, so when writing
@@ -237,29 +250,29 @@ after macro expansion (on gfortran and flang-new):
 
 ```fortran
 ! INCORRECT: cannot use Fortran comments inside macro invocation
-call_assert_diagnose( computed_checksum == expected_checksum, ! ensured since version 3.14
-                      "Checksum mismatch failure!",           ! TODO: write a better message here
-                      computed_checksum )             
+call_assert_describe( computed_checksum == expected_checksum, ! ensured since version 3.14
+                      "Checksum mismatch failure!"            ! TODO: write a better message here
+                    )             
 ```
 
 Depending on your compiler it *might* be possible to use a C-style block
 comment (because they are often removed by the preprocessor), for example with
 gfortran one can instead write the following:
 
 ```fortran
-call_assert_diagnose( computed_checksum == expected_checksum, /* ensured since version 3.14 */ \
-                      "Checksum mismatch failure!",           /* TODO: write a better message here */ \
-                      computed_checksum )
+call_assert_describe( computed_checksum == expected_checksum, /* ensured since version 3.14 */ \
+                      "Checksum mismatch failure!"            /* TODO: write a better message here */ \
+                    )
 ```
 
 However that capability might not be portable to other Fortran compilers. 
 When in doubt, one can always move the comment outside the macro invocation:
 
 ```fortran
 ! assert a property ensured since version 3.14
-call_assert_diagnose( computed_checksum == expected_checksum, \
-                      "Checksum mismatch failure!",           \
-                      computed_checksum ) ! TODO: write a better message above
+call_assert_describe( computed_checksum == expected_checksum, \
+                      "Checksum mismatch failure!"            \
+                    ) ! TODO: write a better message above
 ```                      
 
 Legal Information

index.html

@@ -52,18 +52,14 @@
             <li><a href="./lists/files.html">Source Files</a></li>
             <li><a href="./lists/modules.html">Modules</a></li>
             <li><a href="./lists/procedures.html">Procedures</a></li>
-            <li><a href="./lists/absint.html">Abstract Interfaces</a></li>
-                   <li><a href="./lists/types.html">Derived Types</a></li>
-       
+              
             </ul>
 
             </li>
 <li class="visible-xs hidden-sm visible-lg"><a href="./lists/files.html">Source Files</a></li>
 <li class="visible-xs hidden-sm visible-lg"><a href="./lists/modules.html">Modules</a></li>
 <li class="visible-xs hidden-sm visible-lg"><a href="./lists/procedures.html">Procedures</a></li>
-<li class="visible-xs hidden-sm visible-lg"><a href="./lists/absint.html">Abstract Interfaces</a></li>
-                             <li class="visible-xs hidden-sm visible-lg"><a href="./lists/types.html">Derived Types</a></li>
-          </ul>
+                                       </ul>
         <form action="./search.html" class="navbar-form navbar-right" role="search">
         <div class="form-group">
           <input type="text" class="form-control" placeholder="Search" name="q" id="tipue_search_input" autocomplete="off" required>
@@ -90,40 +86,25 @@ <h1>Assert library</h1>
         </div>
       </div>
       <div class="row">
-        <div class="col-xs-6 col-sm-3">
+        <div class="col-xs-6 col-sm-4">
               <h3>Source Files</h3>
               <ul>                    <li><a href='./sourcefile/assert_m.f90.html'>assert_m.f90</a></li>
                     <li><a href='./sourcefile/assert_subroutine_m.f90.html'>assert_subroutine_m.F90</a></li>
-                    <li><a href='./sourcefile/assert_subroutine_s.f90.html'>assert_subroutine_s.F90</a></li>
-                    <li><a href='./sourcefile/characterizable_m.f90.html'>characterizable_m.f90</a></li>
                     <li><a href='./sourcefile/fortran_stringify_integer_m.f90.html'>fortran_stringify_integer_m.f90</a></li>
-                    <li><a href='./sourcefile/intrinsic_array_m.f90.html'>intrinsic_array_m.F90</a></li>
-                    <li><a href='./sourcefile/intrinsic_array_s.f90.html'>intrinsic_array_s.F90</a></li>
 </ul>
           </div>
-		  <div class="col-xs-6 col-sm-3">
+		  <div class="col-xs-6 col-sm-4">
               <h3>Modules</h3>
               <ul>                    <li><a href='./module/assert_m.html'>assert_m</a></li>
                     <li><a href='./module/assert_subroutine_m.html'>assert_subroutine_m</a></li>
-                    <li><a href='./module/characterizable_m.html'>characterizable_m</a></li>
                     <li><a href='./module/fortran_stringify_integer_m.html'>fortran_stringify_integer_m</a></li>
-                    <li><a href='./module/intrinsic_array_m.html'>intrinsic_array_m</a></li>
 </ul>
           </div>
-		  <div class="col-xs-6 col-sm-3">
+		  <div class="col-xs-6 col-sm-4">
               <h3>Procedures</h3>
-              <ul>                    <li><a href='./proc/allocated_components.html'>allocated_components</a></li>
-                    <li><a href='./interface/as_character.html'>as_character</a></li>
-                    <li><a href='./interface/assert.html'>assert</a></li>
-                    <li><a href='./interface/assert_always.html'>assert_always</a></li>
+              <ul>                    <li><a href='./proc/assert.html'>assert</a></li>
+                    <li><a href='./proc/assert_always.html'>assert_always</a></li>
                     <li><a href='./proc/fortran_stringify_integer.html'>fortran_stringify_integer</a></li>
-                    <li><a href='./interface/intrinsic_array_t.html'>intrinsic_array_t</a></li>
-</ul>
-          </div>
-		  <div class="col-xs-6 col-sm-3">
-              <h3>Derived Types</h3>
-              <ul>                    <li><a href='./type/characterizable_t.html'>characterizable_t</a></li>
-                    <li><a href='./type/intrinsic_array_t.html'>intrinsic_array_t</a></li>
 </ul>
           </div>
       </div>