EPICS Controls Argonne National Laboratory

Experimental Physics and
Industrial Control System

2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024  Index 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
<== Date ==> <== Thread ==>

Subject: Re: Referring to the latest version of our documentation
From: "Johnson, Andrew N. via Core-talk" <core-talk at aps.anl.gov>
To: "Konrad, Martin" <konrad at frib.msu.edu>
Cc: "core-talk at aps.anl.gov" <core-talk at aps.anl.gov>
Date: Fri, 3 Apr 2020 20:42:14 +0000
Hi Martin,

On Apr 3, 2020, at 2:30 PM, Konrad, Martin via Core-talk <core-talk at aps.anl.gov> wrote:

I'm wondering if there is a way to refer to the latest version of our
documentation like the Application Developer's Guide or the Channel
Access Reference manual. I'm looking for a URL that contains something
like "latest" instead of a specific version number. Is there something
like that?

The problem with asking for the “latest version” is that our older doc’s have always been version-specific, so you can’t identify functionality that was added to Base-3.15.6 in the Base-3.16.2 documentation even though the same functionality was merged up from the 3.15 branch into 3.16. We have rarely if ever identified what got added when, although some of the newer PVA module doc’s may do that now. That means even if you ask for the “latest for the 3.15 branch”, you can’t tell from the text whether specific features in it apply to the version of Base you’re using.

The AppDevGuide is being phased out. Branches of it still exist for 3.15 and 3.16, although these haven’t been updated for a while (the last changes were merged in October 2018), but there is no 7.0 branch. We have been working to move the texts worth saving into other places; the libCom APIs to Doxygen annotations that will appear on the 7.0 branch in due course, and some of the other chapters have been converted to pages on https://docs.epics-controls.org/en/latest/ (there’s a “latest” link for you) and linked from the epics-controls.org website.

The Channel Access Reference Manual comes with Base, and we rarely add features to CA anyway so it doesn’t get changed much.

Record reference documentation has been converted from the old Wiki pages and integrated into Base itself so your build generates its own HTML for them; I just added the dbCommon documentation and remaining record types that Rolf Keitel developed at the Codeathon in March, and those can now be found from the APS 3.15.7 release webpage.

Sorry if this doesn’t help, the docs.epics-controls.org link above is probably the best bet for the future, but may not be comprehensive as I don’t think we have plans to install or link to the files from the base/html directories there (I may be wrong about that though).

- Andrew


-- 
Complexity comes for free, simplicity you have to work for.


References:
Referring to the latest version of our documentation Konrad, Martin via Core-talk

Navigate by Date:
Prev: Referring to the latest version of our documentation Konrad, Martin via Core-talk
Next: AW: debugger w/ reverse execution Zimoch Dirk (PSI) via Core-talk
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
Navigate by Thread:
Prev: Referring to the latest version of our documentation Konrad, Martin via Core-talk
Next: add tech-talk and core-talk to gmane Ben Franksen via Core-talk
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
ANJ, 05 Apr 2020 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· Search · EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·