doc
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
PVXS - PVAccess protocol library
|
||||
================================
|
||||
|
||||
VCS - https://github.com/mdavidsaver/pvxs
|
||||
VCS - https://github.com/epics-base/pvxs
|
||||
|
||||
Documentation - https://mdavidsaver.github.io/pvxs/
|
||||
Documentation - https://epics-base.github.io/pvxs/
|
||||
|
||||
@@ -5,7 +5,7 @@ Building from Source
|
||||
|
||||
Begin be fetching all needed source. ::
|
||||
|
||||
git clone --recursive https://github.com/mdavidsaver/pvxs.git
|
||||
git clone --recursive https://github.com/epics-base/pvxs.git
|
||||
git clone --branch 7.0 https://github.com/epics-base/epics-base.git
|
||||
|
||||
Prepare the PVXS source tree with the location of epics-base: ::
|
||||
|
||||
@@ -7,12 +7,12 @@ Details
|
||||
Reporting a Bug
|
||||
===============
|
||||
|
||||
Before reporting a bug, please check to see if this issue has already been `reported <https://github.com/mdavidsaver/pvxs/issues>`_.
|
||||
Before reporting a bug, please check to see if this issue has already been `reported <https://github.com/epics-base/pvxs/issues>`_.
|
||||
|
||||
When composing a new report, please run the included automatic tests "make runtests" and mention the results.
|
||||
It is enough to mention "All tests successful." if this is so. (see `runtests`)
|
||||
|
||||
`Bug reports <https://github.com/mdavidsaver/pvxs/issues>`_ should always include:
|
||||
`Bug reports <https://github.com/epics-base/pvxs/issues>`_ should always include:
|
||||
|
||||
* EPICS Base version or VCS commit
|
||||
* PVXS module version or VCS commit
|
||||
@@ -127,7 +127,7 @@ Elements of the Expert API may be "promoted" to regular/full API status if warra
|
||||
Contributing
|
||||
============
|
||||
|
||||
The recommended path for including changes is through `Pull Request <https://github.com/mdavidsaver/pvxs/pulls>`_.
|
||||
The recommended path for including changes is through `Pull Request <https://github.com/epics-base/pvxs/pulls>`_.
|
||||
|
||||
When changing c++ code please do:
|
||||
|
||||
@@ -151,7 +151,7 @@ When committing changes please do:
|
||||
Contributors
|
||||
------------
|
||||
|
||||
Who did the [work](https://github.com/mdavidsaver/pvxs/graphs/contributors) to make PVXS what it is.
|
||||
Who did the [work](https://github.com/epics-base/pvxs/graphs/contributors) to make PVXS what it is.
|
||||
|
||||
.. comment: git log --format=format:%aN|sort -u|while read aa; do echo "* $aa"; done
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ Examples
|
||||
Example are built, but not installed.
|
||||
They can be found under example/O.\*
|
||||
|
||||
Latest versions https://github.com/mdavidsaver/pvxs/blob/master/example/
|
||||
Latest versions https://github.com/epics-base/pvxs/blob/master/example/
|
||||
|
||||
Shortest Client Get
|
||||
-------------------
|
||||
|
||||
@@ -9,9 +9,9 @@ PVXS is functionally equivalent to the
|
||||
`pvAccessCPP <https://github.com/epics-base/pvAccessCPP>`_ modules,
|
||||
which it hopes to eventually supplant (Ok, the author hopes).
|
||||
|
||||
- VCS: https://github.com/mdavidsaver/pvxs
|
||||
- Docs: https://mdavidsaver.github.io/pvxs
|
||||
- `Issues <https://github.com/mdavidsaver/pvxs/issues>`_ (see :ref:`reportbug`)
|
||||
- VCS: https://github.com/epics-base/pvxs
|
||||
- Docs: https://epics-base.github.io/pvxs
|
||||
- `Issues <https://github.com/epics-base/pvxs/issues>`_ (see :ref:`reportbug`)
|
||||
- :ref:`contrib`
|
||||
|
||||
Dependencies
|
||||
@@ -31,7 +31,7 @@ See :ref:`building` for details.
|
||||
Download
|
||||
--------
|
||||
|
||||
Releases are published to https://github.com/mdavidsaver/pvxs/releases.
|
||||
Releases are published to https://github.com/epics-base/pvxs/releases.
|
||||
See :ref:`relpolicy` for details.
|
||||
|
||||
.. toctree::
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"$id": "https://mdavidsaver.github.io/pvxs/pvalink-schema-0.json",
|
||||
"$id": "https://epics-base.github.io/pvxs/pvalink-schema-0.json",
|
||||
"title": "PVA Link schema",
|
||||
"type": ["string", "object"],
|
||||
"properties": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"$id": "https://mdavidsaver.github.io/pvxs/qsrv2-schema-0.json",
|
||||
"$id": "https://epics-base.github.io/pvxs/qsrv2-schema-0.json",
|
||||
"title": "QSRV2 group schema",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
|
||||
@@ -3,6 +3,14 @@
|
||||
Release Notes
|
||||
=============
|
||||
|
||||
1.3.2 (UNRELEASED)
|
||||
------------------
|
||||
|
||||
* client: Avoid FD leak on failed connect()
|
||||
* Correctly set TCP_NODELAY on winsock
|
||||
* ioc: Workaround asTrapWrite clobbering dbChannel
|
||||
* ioc: ACF fix write permit when groups are present
|
||||
|
||||
1.3.1 (Dec 2023)
|
||||
----------------
|
||||
|
||||
|
||||
+11
-9
@@ -1,17 +1,19 @@
|
||||
# Release Process
|
||||
|
||||
1. Check version number in configure/CONFIG_PVXS_VERSION
|
||||
2. Remove pre-release suffix in setup.py
|
||||
3. Finalize section in documentation/releasenotes.rst
|
||||
1. Check version number in `configure/CONFIG_PVXS_VERSION`
|
||||
2. Remove pre-release suffix in `setup.py`
|
||||
3. Finalize section in `documentation/releasenotes.rst`
|
||||
4. Search/replace `UNRELEASED` tags in doxygen comments
|
||||
|
||||
git grep -l UNRELEASED */pvxs/*.h documentation/*.rst | xargs sed -i -e 's|UNRELEASED|0.0.0|g'
|
||||
```
|
||||
git grep -l UNRELEASED */pvxs/*.h documentation/*.rst | xargs sed -i -e 's|UNRELEASED|0.0.0|g'
|
||||
```
|
||||
|
||||
Don't change in details.rst and releasenotes.rst
|
||||
Don't change in `details.rst` and `releasenotes.rst`
|
||||
|
||||
## Post Release
|
||||
|
||||
1. Update configure/CONFIG_PVXS_VERSION
|
||||
Increment PVXS_MAINTENANCE_VERSION and add new PVXS_#_#_#
|
||||
2. Add pre-release suffix in setup.py
|
||||
3. New section in documentation/releasenotes.rst
|
||||
1. Update `configure/CONFIG_PVXS_VERSION`
|
||||
Increment `PVXS_MAINTENANCE_VERSION` and add new `PVXS_#_#_#`
|
||||
2. Add pre-release suffix in `setup.py`
|
||||
3. New section in `documentation/releasenotes.rst`
|
||||
|
||||
@@ -707,7 +707,7 @@ setup(
|
||||
description="PVXS libraries packaged for python",
|
||||
long_description=long_description,
|
||||
long_description_content_type='text/markdown',
|
||||
url='https://mdavidsaver.github.io/pvxs',
|
||||
url='https://epics-base.github.io/pvxs',
|
||||
author='Michael Davidsaver',
|
||||
author_email='mdavidsaver@gmail.com',
|
||||
license='BSD',
|
||||
|
||||
+2
-2
@@ -53,9 +53,9 @@
|
||||
# define GCC_VERSION VERSION_INT(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__, 0)
|
||||
#endif
|
||||
|
||||
// See https://mdavidsaver.github.io/pvxs/details.html#expertapi
|
||||
// See https://epics-base.github.io/pvxs/details.html#expertapi
|
||||
#if defined(PVXS_EXPERT_API_ENABLED)
|
||||
# error Define PVXS_ENABLE_EXPERT_API to enable usage of Expert API. See https://mdavidsaver.github.io/pvxs/details.html#expert-apis
|
||||
# error Define PVXS_ENABLE_EXPERT_API to enable usage of Expert API. See https://epics-base.github.io/pvxs/details.html#expert-apis
|
||||
#elif defined(PVXS_ENABLE_EXPERT_API)
|
||||
# define PVXS_EXPERT_API_ENABLED
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user