[roc] Update with o2- prefixed names in help dialogs

kostorr · kostorr · commit 953931c70814 · 2021-05-07T15:38:48.000+03:00
diff --git a/src/CommandLineUtilities/ProgramBarStress.cxx b/src/CommandLineUtilities/ProgramBarStress.cxx
@@ -34,7 +34,7 @@ class ProgramBarStress : public Program
   virtual Description getDescription()
   {
     return { "Bar Stress", "Stress the Bar Accessor",
-             "roc-bar-stress --id 04:00.0 --channel=1 --address=0x0f00040 --value=0x18 \n"
+             "o2-roc-bar-stress --id 04:00.0 --channel=1 --address=0x0f00040 --value=0x18 \n"
              "\t--cycles 100000 --print-freq 10000 --sleep=1000" };
   }
 
diff --git a/src/CommandLineUtilities/ProgramCleanup.cxx b/src/CommandLineUtilities/ProgramCleanup.cxx
@@ -35,14 +35,14 @@ class ProgramCleanup : public Program
  public:
   virtual Description getDescription()
   {
-    return { "Cleanup", "Cleans up ReadoutCard state", "roc-cleanup" };
+    return { "Cleanup", "Cleans up ReadoutCard state", "o2-roc-cleanup" };
   }
 
   virtual void addOptions(po::options_description& options)
   {
     options.add_options()("light",
                           po::bool_switch(&mOptions.light)->default_value(false),
-                          "Flag to run a \"light\" roc-cleanup, skipping PDA module removal");
+                          "Flag to run a \"light\" o2-roc-cleanup, skipping PDA module removal");
   }
 
   virtual void run(const po::variables_map&)
@@ -54,12 +54,12 @@ class ProgramCleanup : public Program
     std::cout << "Execution of this tool will:" << std::endl;
     std::cout << "1. Free PDA DMA buffers" << std::endl;
     std::cout << "2. Clean CRORC FIFO shared memory files under /dev/shm which match AliceO2_ROC_*" << std::endl;
-    std::cout << "3. Clean all hugepage resources under /var/lib/hugetlbfs/global/pagesize-{2MB, 1GB}/ which match readout* and roc-bench-dma*" << std::endl;
+    std::cout << "3. Clean all hugepage resources under /var/lib/hugetlbfs/global/pagesize-{2MB, 1GB}/ which match readout* and o2-roc-bench-dma*" << std::endl;
     if (!mOptions.light) {
       std::cout << "4. Remove and reinsert the uio_pci_dma kernel module" << std::endl;
     }
     std::cout << std::endl;
-    std::cout << "In case instances of readout.exe or roc-bench-dma are running, they will fail." << std::endl;
+    std::cout << "In case instances of readout.exe or o2-roc-bench-dma are running, they will fail." << std::endl;
     std::cout << std::endl;
     std::cout << "This tool is intended to be run with elevated privileges." << std::endl;
     std::cout << "Are you sure you want to continue? (yes/no)" << std::endl;
@@ -78,9 +78,9 @@ class ProgramCleanup : public Program
     sysCheckRet("rm /var/lib/hugetlbfs/global/pagesize-2MB/readout*");
     std::cout << "Removing readout 1GB hugepage mappings" << std::endl;
     sysCheckRet("rm /var/lib/hugetlbfs/global/pagesize-1GB/readout*");
-    std::cout << "Removing roc-bench-dma 2MB hugepage mappings" << std::endl;
+    std::cout << "Removing o2-roc-bench-dma 2MB hugepage mappings" << std::endl;
     sysCheckRet("rm /var/lib/hugetlbfs/global/pagesize-2MB/roc-bench-dma*");
-    std::cout << "Removing roc-bench-dma 1GB hugepage mappings" << std::endl;
+    std::cout << "Removing o2-roc-bench-dma 1GB hugepage mappings" << std::endl;
     sysCheckRet("rm /var/lib/hugetlbfs/global/pagesize-1GB/roc-bench-dma*");
 
     if (!mOptions.light) {
diff --git a/src/CommandLineUtilities/ProgramConfig.cxx b/src/CommandLineUtilities/ProgramConfig.cxx
@@ -39,9 +39,9 @@ class ProgramConfig : public Program
   virtual Description getDescription()
   {
     return { "Config", "Configure the ReadoutCard(s)",
-             "roc-config --config-uri ini:///home/flp/roc.cfg\n"
-             "roc-config --id 42:00.0 --links 0-23 --clock local --datapathmode packet --loopback --gbtmux ttc #CRU\n"
-             "roc-config --id #0 --crorc-id 0x42 --dyn-offset --tf-length 255 #CRORC\n" };
+             "o2-roc-config --config-uri ini:///home/flp/roc.cfg\n"
+             "o2-roc-config --id 42:00.0 --links 0-11 --clock local --datapathmode packet --loopback --gbtmux ttc #CRU\n"
+             "o2-roc-config --id #0 --crorc-id 0x42 --dyn-offset --tf-length 255 #CRORC\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
@@ -108,7 +108,7 @@ class ProgramConfig : public Program
                           "Flag to enable the Time Frame Detection");
     options.add_options()("gen-cfg-file",
                           po::value<std::string>(&mOptions.genConfigFile),
-                          "If set generates a configuration file from the command line options. [DOES NOT CONFIGURE]");
+                          "If set generates a CRU configuration file from the command line options. [DOES NOT CONFIGURE]");
     options.add_options()("no-gbt",
                           po::bool_switch(&mOptions.noGbt),
                           "Flag to switch off GBT");
diff --git a/src/CommandLineUtilities/ProgramCtpEmulator.cxx b/src/CommandLineUtilities/ProgramCtpEmulator.cxx
@@ -38,7 +38,7 @@ class ProgramCtpEmulator : public Program
   virtual Description getDescription()
   {
     return { "CTP Emulator", "Emulate CTP functionality",
-             "roc-ctp-emulator --id 42:00.0 --trigger-mode continuous\n" };
+             "o2-roc-ctp-emulator --id 42:00.0 --trigger-mode continuous\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
@@ -55,7 +55,7 @@ class ProgramCtpEmulator : public Program
                           "Sets the number of Heartbeats to keep");
     options.add_options()("hbkeep",
                           po::value<uint32_t>(&mOptions.hbKeep)->default_value(15000),
-                          "Sets the number Heartbeats to drop");
+                          "Sets the number of Heartbeats to drop");
     options.add_options()("init-orbit",
                           po::value<std::string>(&mOptions.orbitInit)->default_value("0x0"),
                           "Sets the initial orbit id");
diff --git a/src/CommandLineUtilities/ProgramDmaBench.cxx b/src/CommandLineUtilities/ProgramDmaBench.cxx
@@ -113,7 +113,7 @@ class ProgramDmaBench : public Program
       "README.md for more information.\n"
       "The options specifying a size take power-of-10 and power-of-2 unit prefixes. For example '--bytes=1T' "
       "(1 terabyte) or '--buffer-size=1Gi' (1 gibibyte)",
-      "roc-bench-dma --verbose --id=42:0.0 --bytes=10G"
+      "o2-roc-bench-dma --verbose --id=42:0.0 --bytes=10G"
     };
   }
 
@@ -255,7 +255,7 @@ class ProgramDmaBench : public Program
       BOOST_THROW_EXCEPTION(ParameterException() << ErrorInfo::Message("Buffer size smaller than superpage size"));
     }
 
-    std::string bufferName = (b::format("roc-bench-dma_id=%s_chan=%s_pages") % map["id"].as<std::string>() % mOptions.dmaChannel).str();
+    std::string bufferName = (b::format("o2-roc-bench-dma_id=%s_chan=%s_pages") % map["id"].as<std::string>() % mOptions.dmaChannel).str();
 
     Utilities::HugepageType hugepageType;
     mMemoryMappedFile = Utilities::tryMapFile(mBufferSize, bufferName, !mOptions.noRemovePagesFile, &hugepageType);
diff --git a/src/CommandLineUtilities/ProgramFirmwareCheck.cxx b/src/CommandLineUtilities/ProgramFirmwareCheck.cxx
@@ -32,7 +32,7 @@ class ProgramFirmwareCheck : public Program
   virtual Description getDescription()
   {
     return { "Firmware Check", "Check firmware compatibility of the ReadoutCard(s)",
-             "roc-fw-check\n" };
+             "o2-roc-fw-check\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description&)
diff --git a/src/CommandLineUtilities/ProgramFlash.cxx b/src/CommandLineUtilities/ProgramFlash.cxx
@@ -34,7 +34,7 @@ class ProgramCrorcFlash : public Program
  public:
   virtual Description getDescription()
   {
-    return { "Flash", "Programs the card's flash memory", "roc-flash --id=12345 --file=/dir/my_file" };
+    return { "Flash", "Programs the card's flash memory", "o2-roc-flash --id=12345 --file=/dir/my_file" };
   }
 
   virtual void addOptions(po::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramFlashRead.cxx b/src/CommandLineUtilities/ProgramFlashRead.cxx
@@ -33,7 +33,7 @@ class ProgramCrorcFlash : public Program
   virtual Description getDescription()
   {
     return { "Flash Read", "Reads card flash memory",
-             "roc-flash-read --id=12345 --address=0 --words=32" };
+             "o2-roc-flash-read --id=12345 --address=0 --words=32" };
   }
 
   virtual void addOptions(po::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramListCards.cxx b/src/CommandLineUtilities/ProgramListCards.cxx
@@ -40,8 +40,8 @@ class ProgramListCards : public Program
   virtual Description getDescription()
   {
     return { "List Cards", "Lists installed cards and some basic information about them",
-             "roc-list-cards\n"
-             "roc-list-cards --json" };
+             "o2-roc-list-cards\n"
+             "o2-roc-list-cards --json" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramMetrics.cxx b/src/CommandLineUtilities/ProgramMetrics.cxx
@@ -39,9 +39,9 @@ class ProgramMetrics : public Program
   virtual Description getDescription()
   {
     return { "Metrics", "Return current RoC parameters",
-             "roc-metrics \n"
-             "roc-metrics --json \n"
-             "roc-metrics --monitoring\n" };
+             "o2-roc-metrics \n"
+             "o2-roc-metrics --json \n"
+             "o2-roc-metrics --monitoring\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramPacketMonitor.cxx b/src/CommandLineUtilities/ProgramPacketMonitor.cxx
@@ -37,9 +37,9 @@ class ProgramPacketMonitor : public Program
   virtual Description getDescription()
   {
     return { "Packet Monitor", "Return RoC packet monitoring information",
-             "roc-pkt-monitor --id 42:00.0\n"
-             "roc-pkt-monitor --id 42:00.0 --json\n"
-             "roc-pkt-monitor --id 42:00.0 --monitoring\n" };
+             "o2-roc-pkt-monitor --id 42:00.0\n"
+             "o2-roc-pkt-monitor --id 42:00.0 --json\n"
+             "o2-roc-pkt-monitor --id 42:00.0 --monitoring\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramPatternPlayer.cxx b/src/CommandLineUtilities/ProgramPatternPlayer.cxx
@@ -37,7 +37,7 @@ class ProgramPatternPlayer : public Program
   virtual Description getDescription()
   {
     return { "PatternPlayer", "Configure the CRU pattern player",
-             "roc-pat-player --id 42:00.0 --sync 0x0123457899876543210abcdefedcb --sync-length 4 --sync-delay 2 --sync-at-start\n" };
+             "o2-roc-pat-player --id 42:00.0 --sync 0x0123457899876543210abcdefedcb --sync-length 4 --sync-delay 2 --sync-at-start\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramRegisterModify.cxx b/src/CommandLineUtilities/ProgramRegisterModify.cxx
@@ -27,7 +27,7 @@ class ProgramRegisterModify : public Program
   virtual Description getDescription()
   {
     return { "Modify Register", "Modify bits of a single register",
-             "roc-reg-modify --id=12345 --channel=0 --address=0x8 --position=3 --width=1 --value=0" };
+             "o2-roc-reg-modify --id=12345 --channel=0 --address=0x8 --position=3 --width=1 --value=0" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramRegisterRead.cxx b/src/CommandLineUtilities/ProgramRegisterRead.cxx
@@ -26,7 +26,7 @@ class ProgramRegisterRead : public Program
  public:
   virtual Description getDescription()
   {
-    return { "Read Register", "Read a single register", "roc-reg-read --id=12345 --channel=0 --address=0x8" };
+    return { "Read Register", "Read a single register", "o2-roc-reg-read --id=12345 --channel=0 --address=0x8" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramRegisterReadRange.cxx b/src/CommandLineUtilities/ProgramRegisterReadRange.cxx
@@ -30,7 +30,7 @@ class ProgramRegisterReadRange : public Program
   virtual Description getDescription()
   {
     return { "Read Register Range", "Read a range of registers",
-             "roc-reg-read-range --id=12345 --channel=0 --address=0x8 --range=10" };
+             "o2-roc-reg-read-range --id=12345 --channel=0 --address=0x8 --range=10" };
   }
 
   virtual void addOptions(po::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramRegisterWrite.cxx b/src/CommandLineUtilities/ProgramRegisterWrite.cxx
@@ -29,7 +29,7 @@ class ProgramRegisterWrite : public Program
   virtual Description getDescription()
   {
     return { "Write Register", "Write a value to a single register",
-             "roc-reg-write --id=12345 --channel=0 --address=0x8 --value=0" };
+             "o2-roc-reg-write --id=12345 --channel=0 --address=0x8 --value=0" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramReset.cxx b/src/CommandLineUtilities/ProgramReset.cxx
@@ -27,7 +27,7 @@ class ProgramReset : public Program
  public:
   virtual Description getDescription()
   {
-    return { "Reset", "Resets a channel", "roc-reset --id=12345 --channel=0 --reset=INTERNAL_SIU" };
+    return { "Reset", "Resets a channel", "o2-roc-reset --id=12345 --channel=0 --reset=INTERNAL_SIU" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramSiuStatus.cxx b/src/CommandLineUtilities/ProgramSiuStatus.cxx
@@ -34,7 +34,7 @@ class ProgramSiuStatus : public Program
   virtual Description getDescription()
   {
     return { "SIU Status", "Report SIU Status",
-             "roc-siu-status --id=42:00.0 --channel=2" };
+             "o2-roc-siu-status --id=42:00.0 --channel=2" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramStatus.cxx b/src/CommandLineUtilities/ProgramStatus.cxx
@@ -41,9 +41,9 @@ class ProgramStatus : public Program
   virtual Description getDescription()
   {
     return { "Status", "Return current RoC configuration status",
-             "roc-status --id 42:00.0\n"
-             "roc-status --id 42:00.0 --json\n"
-             "roc-status --id 42:00.0 --monitoring\n" };
+             "o2-roc-status --id 42:00.0\n"
+             "o2-roc-status --id 42:00.0 --json\n"
+             "o2-roc-status --id 42:00.0 --monitoring\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramTriggerMonitor.cxx b/src/CommandLineUtilities/ProgramTriggerMonitor.cxx
@@ -32,8 +32,8 @@ class ProgramTriggerMonitor : public Program
   virtual Description getDescription()
   {
     return { "Trigger Monitor", "Return LTU trigger monitoring information",
-             "roc-pkt-monitor --id 42:00.0\n"
-             "roc-pkt-monitor --id 42:00.0 --updateable\n" };
+             "o2-roc-pkt-monitor --id 42:00.0\n"
+             "o2-roc-pkt-monitor --id 42:00.0 --updateable\n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)
diff --git a/src/CommandLineUtilities/ProgramUserLogic.cxx b/src/CommandLineUtilities/ProgramUserLogic.cxx
@@ -29,9 +29,9 @@ class ProgramUserLogic : public Program
   virtual Description getDescription()
   {
     return { "User Logic", "Control the dummy User Logic",
-             "roc-ul --id 0042:0 --event-size=128 \n"
-             "roc-ul --id 0042:0 --random-event-size \n"
-             "roc-ul --id 0042:0 --status \n" };
+             "o2-roc-ul --id 0042:0 --event-size=128 \n"
+             "o2-roc-ul --id 0042:0 --random-event-size \n"
+             "o2-roc-ul --id 0042:0 --status \n" };
   }
 
   virtual void addOptions(boost::program_options::options_description& options)

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class ProgramBarStress : public Program`
`34`	`34`	`virtual Description getDescription()`
`35`	`35`	`{`
`36`	`36`	`return { "Bar Stress", "Stress the Bar Accessor",`
`37`		`- "roc-bar-stress --id 04:00.0 --channel=1 --address=0x0f00040 --value=0x18 \n"`
	`37`	`+ "o2-roc-bar-stress --id 04:00.0 --channel=1 --address=0x0f00040 --value=0x18 \n"`
`38`	`38`	`"\t--cycles 100000 --print-freq 10000 --sleep=1000" };`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ class ProgramDmaBench : public Program`
`113`	`113`	`"README.md for more information.\n"`
`114`	`114`	`"The options specifying a size take power-of-10 and power-of-2 unit prefixes. For example '--bytes=1T' "`
`115`	`115`	`"(1 terabyte) or '--buffer-size=1Gi' (1 gibibyte)",`
`116`		`- "roc-bench-dma --verbose --id=42:0.0 --bytes=10G"`
	`116`	`+ "o2-roc-bench-dma --verbose --id=42:0.0 --bytes=10G"`
`117`	`117`	`};`
`118`	`118`	`}`
`119`	`119`
`@@ -255,7 +255,7 @@ class ProgramDmaBench : public Program`
`255`	`255`	`BOOST_THROW_EXCEPTION(ParameterException() << ErrorInfo::Message("Buffer size smaller than superpage size"));`
`256`	`256`	`}`
`257`	`257`
`258`		`- std::string bufferName = (b::format("roc-bench-dma_id=%s_chan=%s_pages") % map["id"].as<std::string>() % mOptions.dmaChannel).str();`
	`258`	`+ std::string bufferName = (b::format("o2-roc-bench-dma_id=%s_chan=%s_pages") % map["id"].as<std::string>() % mOptions.dmaChannel).str();`
`259`	`259`
`260`	`260`	`Utilities::HugepageType hugepageType;`
`261`	`261`	`mMemoryMappedFile = Utilities::tryMapFile(mBufferSize, bufferName, !mOptions.noRemovePagesFile, &hugepageType);`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class ProgramFirmwareCheck : public Program`
`32`	`32`	`virtual Description getDescription()`
`33`	`33`	`{`
`34`	`34`	`return { "Firmware Check", "Check firmware compatibility of the ReadoutCard(s)",`
`35`		`- "roc-fw-check\n" };`
	`35`	`+ "o2-roc-fw-check\n" };`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`virtual void addOptions(boost::program_options::options_description&)`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class ProgramCrorcFlash : public Program`
`34`	`34`	`public:`
`35`	`35`	`virtual Description getDescription()`
`36`	`36`	`{`
`37`		`- return { "Flash", "Programs the card's flash memory", "roc-flash --id=12345 --file=/dir/my_file" };`
	`37`	`+ return { "Flash", "Programs the card's flash memory", "o2-roc-flash --id=12345 --file=/dir/my_file" };`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`virtual void addOptions(po::options_description& options)`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ class ProgramCrorcFlash : public Program`
`33`	`33`	`virtual Description getDescription()`
`34`	`34`	`{`
`35`	`35`	`return { "Flash Read", "Reads card flash memory",`
`36`		`- "roc-flash-read --id=12345 --address=0 --words=32" };`
	`36`	`+ "o2-roc-flash-read --id=12345 --address=0 --words=32" };`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`virtual void addOptions(po::options_description& options)`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ class ProgramListCards : public Program`
`40`	`40`	`virtual Description getDescription()`
`41`	`41`	`{`
`42`	`42`	`return { "List Cards", "Lists installed cards and some basic information about them",`
`43`		`- "roc-list-cards\n"`
`44`		`- "roc-list-cards --json" };`
	`43`	`+ "o2-roc-list-cards\n"`
	`44`	`+ "o2-roc-list-cards --json" };`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`virtual void addOptions(boost::program_options::options_description& options)`
Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,9 @@ class ProgramMetrics : public Program`
`39`	`39`	`virtual Description getDescription()`
`40`	`40`	`{`
`41`	`41`	`return { "Metrics", "Return current RoC parameters",`
`42`		`- "roc-metrics \n"`
`43`		`- "roc-metrics --json \n"`
`44`		`- "roc-metrics --monitoring\n" };`
	`42`	`+ "o2-roc-metrics \n"`
	`43`	`+ "o2-roc-metrics --json \n"`
	`44`	`+ "o2-roc-metrics --monitoring\n" };`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`virtual void addOptions(boost::program_options::options_description& options)`