All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
settings.sh
Go to the documentation of this file.
1 #!/usr/bin/env bash
2 #
3 # General settings for the scripts in this directory.
4 # Override the settings in `experiment_settings.sh`.
5 #
6 # Usage:
7 #
8 # # -- BEGIN -- boilerplate settings and library loading -------------------------
9 # SCRIPTNAME="$(basename "$0")"
10 # SCRIPTDIR="$(dirname "$0")"
11 #
12 # declare LibraryToLoad
13 # for LibraryToLoad in 'settings.sh' 'experiment_settings.sh' 'utilities.sh' ; do
14 #
15 # source "${SCRIPTDIR%/}/${LibraryToLoad}" || exit $?
16 #
17 # done
18 # unset LibraryToLoad
19 # # -- END -- boilerplate settings and library loading ---------------------------
20 #
21 
22 declare DefaultExperimentName='ICARUS'
23 
24 # name for a log directory (scripts may set it where they want)
25 declare LogDir='logs'
26 
27 # the GIT branch or commit to check out before generating the documentation.
28 declare DefaultBranch='master'
29 
30 # the subdirectory under the GIT repository where documentation generation might be found
31 declare RepoDocSubdir='doc'
32 
33 # where the content is published
34 declare PublishBaseDir='/web/sites/i/icarus-exp.fnal.gov/htdocs/at_work/software/doc'
35 
36 # directory of Doxygen generation metadata, relative to Doxygen output directory
37 declare MetadataFileRelPath='meta/doxygen'
38 
39 # name of the index file for package software versions (must match the hard-coded name from the web site)
40 declare VersionListFile='versionlist.html'
41 
42 # name of the current version of the software
43 declare LatestLinkName='latest'
44 
45 # GitHub group name for fetching code
46 declare GitHubExperimentGroup='SBNSoftware'