Skip to content

Commit

Permalink
kappa: updated configecho documentation and ifd.
Browse files Browse the repository at this point in the history
The documentation now gives more detail about the new NDF and
APPLICATION parameters.  Also added ppath and vpath values
for these parameters to the kappa.ifd.in file.
  • Loading branch information
grahambell committed Feb 15, 2013
1 parent 0d9368d commit 9425a4d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
4 changes: 4 additions & 0 deletions applications/kappa/kappa.ifd.in
Expand Up @@ -9835,6 +9835,8 @@ package kappa {

parameter application {
type LITERAL
ppath CURRENT DEFAULT
vpath CURRENT DEFAULT
prompt {Application for which to find configuration}
helpkey *
default !
Expand Down Expand Up @@ -9878,6 +9880,8 @@ package kappa {

parameter ndf {
access READ
ppath CURRENT DEFAULT
vpath DEFAULT
prompt {NDF from which to read configuration}
helpkey *
default !
Expand Down
22 changes: 20 additions & 2 deletions applications/kappa/libkappa/configecho.c
Expand Up @@ -44,6 +44,9 @@ F77_SUBROUTINE(configecho)( INTEGER(STATUS) ){
* The value is also written to an output parameter. If the
* parameter is not specified by the CONFIG or DEFAULTS parameter,
* then the value supplied for DEFVAL is returned.
*
* If an input NDF is supplied then configuration parameters
* are read from its history (see Parameters NDF and APPLICATION).
* Usage:
* configecho name config [defaults] [select] [defval]
Expand All @@ -52,7 +55,9 @@ F77_SUBROUTINE(configecho)( INTEGER(STATUS) ){
* APPLICATION = LITERAL (Read)
* When reading configuration parameters from the history
* of an NDF, specifies the name of the application to find
* in the history.
* in the history. There must be a history component
* corresponding to the value of this parameter, and it
* must include a CONFIG group. [!]
* CONFIG = GROUP (Read)
* Specifies values for the configuration parameters. If the string
* "def" (case-insensitive) or a null (!) value is supplied, a set
Expand Down Expand Up @@ -90,7 +95,16 @@ F77_SUBROUTINE(configecho)( INTEGER(STATUS) ){
* then all parameters defined in the configuration are displayed.
* NDF = NDF (Read)
* An NDF file containing history entries which include
* configuration parameters.
* configuration parameters. If not null (!) the history
* of the NDF will be searched for a component corresponding
* to the Parameter APPLICATION. The Parameter CONFIG
* is then optional, but if it too is not null (!) then
* the output will show the differences between the configuration
* stored in the NDF history and the given configuration:
* new parameters and those different from the reference
* configuration (given by Parameter CONFIG) are prefixed
* with "+" and those which are the same as the reference
* configuration are prefixed with "-". [!]
* SELECT = GROUP (Read)
* A group that specifies any alternative prefixes that can be
* included at the start of any parameter name. For instance, if
Expand Down Expand Up @@ -138,6 +152,10 @@ F77_SUBROUTINE(configecho)( INTEGER(STATUS) ){
* then it is searched for "450.flt.filt_edge_largescale" instead. An
* error is reported if dimmconfig.lis contains values for any
* items that are not defined in smurf_makemap.def.
* configecho ndf=omc1 config=^/star/share/smurf/dimmconfig.lis \
* application=makemap name=! sort=true select="'450=0,850=1'"
* Show how the configuration used to generate the 850um map
* of OMC1 differs from the basic dimmconfig.lis file.
* Copyright:
* Copyright (C) 2012 Science & Technology Facilities Council.
Expand Down

0 comments on commit 9425a4d

Please sign in to comment.