Warning, /FWCore/MessageService/doc/fwkjobReport-suppression-plan is written in an unsupported language. File is not indexed.
0001
0002
0003 1 - Remove the mention of the fwkJobReports destination from the .cfi file:
0004 the affected lines are
0005
0006
0007 untracked vstring fwkJobReports = {"FrameworkJobReport"}
0008
0009 untracked PSet FrameworkJobReport = {
0010 untracked PSet default = { untracked int32 limit = 0 }
0011 untracked PSet FwkJob = { untracked int32 limit = 10000000 }
0012 }
0013
0014 2 - By default no fwkJobReports destinations are created.
0015
0016 3 - Check for the command-line option --jobreport or --jobreport=<name>
0017
0018 4 - Equivalent options are -j or -j=<name>
0019
0020 5 - If --jobreport=<name> appears, behave as if the .cfg file contained
0021 untracked vstring --jobreport = {"name"} (supplying the extension .xml
0022 if it is not already present), with the defaults currently set in the
0023 .cfi file hardwired in to the code.
0024
0025 6 - If --jobreport (without specifying a name) appears, behave as if the
0026 precise lines which were excised from the .cfi file were present, thus
0027 creating FrameworkJobReport.xml.
0028
0029 7 - If --jobreport appears (with or without a name) AND the .cfg file
0030 also has one or more fwkJobReports destinations, create all these
0031 destinations plus the one caused by --jobreport. (But if the name
0032 of the --jobreport destination matches one of the explicitly specified
0033 names in the .cfg file, do not create the extra destination instigated
0034 by the comand-line option.
0035
0036 8 - An additional command-line option, --nojobreport, causes the suppression
0037 of all --jobreport destinations, both those mentioned in a .cfg file and
0038 those mentioned in a --jobreport option.
0039
0040 As a development matter, we provide a symbol
0041 #define DEFINE_THIS_TO_MAKE_REPORTS_THE_DEFAULT
0042 to let the default behavior remain as before, which is helpful for testing.
0043
0044 The technique is to convey the contents of the --jobreport option to
0045 make it avalable in configure_fwkJobReports. If there is no option
0046 specified, the option will be the empty string; if there is one without
0047 a name, the option will be transmitted as "*". Then there is a two-step
0048 decision process. In the first step there are 5 possibilities for the option
0049 and two possibilities for DEFINE_THIS_TO_MAKE_REPORTS_THE_DEFAULT
0050
0051 (a) option = ""
0052 Job reports are disabled or enabled according to
0053 whether DEFINE_THIS_TO_MAKE_REPORTS_THE_DEFAULT is defined.
0054 option is left as "".
0055
0056 (b) option = "~"
0057 Job reports are disabled no matter what.
0058
0059 (c) option = "*" indicating --jobreports without a specific name.
0060 Job reports are enabled.
0061
0062 (d) option = name (without an extension):
0063 Job reports are enabled.
0064 The extension .xml is tacked on to option.
0065
0066 (e) option = name.extension:
0067 Job reports are enabled.
0068
0069 Then if job reports are now enabled, each job report destination mentioned in
0070 the .cfg file is configured. We note whether after this jobReportExists.
0071
0072 The second decision step then step happens (if job reports are enabled):
0073
0074 (a) option = ""(which can only occur if DEFINE_THIS_TO_MAKE_REPORTS_THE_DEFAULT)
0075 Since no job report was requested on the command line, no job report
0076 is made, and we can return.
0077
0078 (b) option = "~" -- cannot be the case at this point, since reports are enabled
0079
0080 (c) option = "*"
0081 If jobReportExists we are in fact reporting, so nothing further needs
0082 to be done. Otherwise, change option to FrameworkJobReport.xml
0083
0084 (d,e) option = name.extension
0085 If that name matches a framework job report actual file name, we need
0086 do nothing more. Otherwise, configure a framework job destination
0087 by the name of FrameworkJobReport.xml
0088
0089 Finally, if we have not returned, we need to configure the destination, but
0090 this is a special version because we don't have a PSet yet we want to act
0091 as if we had
0092
0093 untracked PSet FrameworkJobReport = {
0094 untracked PSet default = { untracked int32 limit = 0 }
0095 untracked PSet FwkJob = { untracked int32 limit = 10000000 }
0096 }
