2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 <2020> 2021 2022 2023 2024 2025 | Index | 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 <2020> 2021 2022 2023 2024 2025 |
<== Date ==> | <== Thread ==> |
---|
Subject: | Re: IOC shell usage messages |
From: | "Johnson, Andrew N. via Core-talk" <core-talk at aps.anl.gov> |
To: | Michael Davidsaver <mdavidsaver at gmail.com> |
Cc: | EPICS core-talk <core-talk at aps.anl.gov> |
Date: | Mon, 27 Apr 2020 17:07:09 +0000 |
On Apr 24, 2020, at 10:52 PM, Michael Davidsaver via Core-talk <core-talk at aps.anl.gov> wrote:
Looks good.
Most of the built-in commands are actually described in the AppDevGuide reasonably well, although the commands are usually embedded in the chapters describing their associated subsystem, and we have probably added functionality to some commands without
documenting it there. In most cases the wording there would probably have been too verbose for this, but the docs might describe features that could be mentioned in the help text.
Anyone who has read the Release Notes for Base-3.14.7 (admittedly rather terse), or the AppDevGuide documentation chapter on iocsh perhaps? This is from chapter 18 of the 3.14 Guide; the wildcard feature was added in 2004:
help [command ...] Display synopsis of specified commands. Wild-card matching is applied so ‘help db*’ displays a synopsis of all commands beginning with the letters ‘db’. With no arguments display a list of all commands. Thanks,
- Andrew
--
Complexity comes for free, simplicity you have to work for.
|