From 9b521ade2743af52687bc039b30a49d2c4bf5587 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Tue, 19 Oct 2021 09:59:49 +0200 Subject: [PATCH] help fixed --- slsDetectorSoftware/include/sls/Detector.h | 22 +++++++------- slsDetectorSoftware/src/CmdProxy.cpp | 34 ++++++++++++---------- 2 files changed, 30 insertions(+), 26 deletions(-) diff --git a/slsDetectorSoftware/include/sls/Detector.h b/slsDetectorSoftware/include/sls/Detector.h index 265e9af8a..af44855fe 100644 --- a/slsDetectorSoftware/include/sls/Detector.h +++ b/slsDetectorSoftware/include/sls/Detector.h @@ -1719,10 +1719,11 @@ class Detector { * * * ************************************************/ - /** Advanced user Function! - * [Jungfrau][CTB][Moench] fname is a pof file, rebooting the controller is - * recommended \n [Mythen3][Gotthard2] fname is an rbf file, power cycling - * the detector is recommended + /** [Jungfrau][Gotthard][CTB][Moench][Mythen3][Gotthard2] + * Advanced user Function! + * Program firmware from command line, after which detector controller is + * rebooted. [Jungfrau][CTB][Moench] fname is a pof file (full path) \n + * [Mythen3][Gotthard2] fname is an rbf file (full path) */ void programFPGA(const std::string &fname, Positions pos = {}); @@ -1732,7 +1733,8 @@ class Detector { /** [Jungfrau][Eiger][Gotthard][CTB][Moench][Mythen3][Gotthard2] * Advanced user Function! \n * Copy detector server fname from tftp folder of hostname to detector. Also - * creates a symbolic link to a shorter name (without vx.x.x) \n + * creates a symbolic link to a shorter name (without vx.x.x). Then the + * detector controller reboots (except eiger) \n * [Jungfrau][Gotthard][CTB][Moench] Also changes respawn server (to the * link), which is effective after a reboot. */ @@ -1745,11 +1747,11 @@ class Detector { /** * Advanced user Function!\n [Jungfrau][Gotthard][CTB][Moench] Updates the - * firmware, detector server and then reboots detector controller blackfin. - * \n [Mythen3][Gotthard2] Will still have old server starting up as the new - * server is not respawned \n sname is name of detector server binary found - * on tftp folder of host pc \n hostname is name of pc to tftp from \n fname - * is programming file name + * firmware, detector server, make a soft link and then reboots detector + * controller. \n [Mythen3][Gotthard2] Will require a script to start up the + * shorter namedf server link at start up \n sname is name of detector + * server binary found on tftp folder of host pc \n hostname is name of pc + * to tftp from \n fname is programming file name with full path to it */ void updateFirmwareAndServer(const std::string &sname, const std::string &hostname, diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp index 6eaa7776b..bb1fd3321 100644 --- a/slsDetectorSoftware/src/CmdProxy.cpp +++ b/slsDetectorSoftware/src/CmdProxy.cpp @@ -2819,10 +2819,11 @@ std::string CmdProxy::ProgramFpga(int action) { std::ostringstream os; os << cmd << ' '; if (action == defs::HELP_ACTION) { - os << "[fname.pof | fname.rbf]\n\t[Jungfrau][Ctb][Moench] Programs " - "FPGA from pof file. Rebooting controller is recommended. " - "\n\t[Mythen3][Gotthard2] Programs FPGA from rbf file. Power " - "cycling the detector is recommended. " + os << "[fname.pof | fname.rbf (full path)]\n\t[Jungfrau][Ctb][Moench] " + "Programs FPGA from pof file (full path). Then, detector " + "controller is rebooted \n\t[Mythen3][Gotthard2] Programs FPGA " + "from rbf file (full path). Then, detector controller is " + "rebooted." << '\n'; } else if (action == defs::GET_ACTION) { throw sls::RuntimeError("Cannot get"); @@ -2842,11 +2843,12 @@ std::string CmdProxy::CopyDetectorServer(int action) { std::ostringstream os; os << cmd << ' '; if (action == defs::HELP_ACTION) { - os << "[server_name] " + os << "[server_name (in tftp folder)] " "[pc_host_name]\n\t[Jungfrau][Eiger][Ctb][Moench][Mythen3][" - "Gotthard2] Copies detector server via tftp from pc. Makes a " - "symbolic link witha shorter name (without " - "vx.x.x).\n\t[Jungfrau][Ctb][Moench]Also changes respawn server " + "Gotthard2] Copies detector server via tftp from pc. Ensure that " + "server is in the pc's tftp folder. Makes a symbolic link with a " + "shorter name (without vx.x.x). Then, detector reboots (except " + "Eiger).\n\t[Jungfrau][Ctb][Moench]Also changes respawn server " "to the link, which is effective after a reboot." << '\n'; } else if (action == defs::GET_ACTION) { @@ -2867,14 +2869,14 @@ std::string CmdProxy::UpdateFirmwareAndDetectorServer(int action) { std::ostringstream os; os << cmd << ' '; if (action == defs::HELP_ACTION) { - os << "[server_name] [pc_host_name] " - "[fname.pof]\n\t[Jungfrau][Gotthard][CTB][Moench] Updates the " - "firmware, detector server and then reboots detector controller " - "blackfin. \n\t[Mythen3][Gotthard2] Will still have old server " - "starting up as the new server is not respawned \n\tsname is " - "name of detector server binary found on tftp folder of host pc " - "\n\thostname is name of pc to tftp from \n\tfname is " - "programming file name" + os << "[server_name (in tftp folder)] [pc_host_name] [fname.pof (incl " + "full path)]\n\t[Jungfrau][Gotthard][CTB][Moench] Updates the " + "firmware, detector server, creates teh symbolic link and then " + "reboots detector controller. \n\t[Mythen3][Gotthard2] will " + "require a script to start up the shorter named server link at " + "start up. \n\tsname is name of detector server binary found on " + "tftp folder of host pc \n\thostname is name of pc to tftp from " + "\n\tfname is programming file name" << '\n'; } else if (action == defs::GET_ACTION) { throw sls::RuntimeError("Cannot get");