Skip to content

Commit a8edddc

Browse files
pcisarpcisar
committed
Format changes and sphinx-related updates
1 parent c69479d commit a8edddc

12 files changed

Lines changed: 1107 additions & 463 deletions

File tree

‎conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# -- Project information -----------------------------------------------------
2222

2323
project = u'Firebird Butler'
24-
copyright = u'2018, Firebird Butler Project, CC BY-SA 4.0'
24+
copyright = u'2018-2022, Firebird Butler Project, CC BY-SA 4.0'
2525
author = u'Pavel Cisar'
2626

2727
# The short X.Y version
@@ -66,7 +66,7 @@
6666
#
6767
# This is also used if you do content translation via gettext catalogs.
6868
# Usually you set "language" from the command line for these cases.
69-
language = None
69+
language = 'en'
7070

7171
# List of patterns, relative to source directory, that match files and
7272
# directories to ignore when looking for source files.

‎requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
sphinx-bootstrap-theme>=0.7.0
1+
sphinx-bootstrap-theme>=0.8.1
22
aafigure>=0.6

‎rfc/1/C4.rst‎

Lines changed: 112 additions & 51 deletions
Large diffs are not rendered by default.

‎rfc/2/COSS.rst‎

Lines changed: 100 additions & 39 deletions
Large diffs are not rendered by default.

‎rfc/3/FBSD.rst‎

Lines changed: 157 additions & 56 deletions
Large diffs are not rendered by default.

‎rfc/4/FBSP.rst‎

Lines changed: 309 additions & 117 deletions
Large diffs are not rendered by default.

‎rfc/4/zmqfbsp.proto‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// ZeroMQ 4.2 socket types
2+
3+
enum ZMQSocketType {
4+
UNKNOWN = 0 ;
5+
ROUTER = 1 ;
6+
DEALER = 2 ;
7+
PUB = 3 ;
8+
XPUB = 4 ;
9+
SUB = 5 ;
10+
XSUB = 6 ;
11+
PUSH = 7 ;
12+
PULL = 8 ;
13+
PAIR = 9 ;
14+
STREAM = 10 ;
15+
CLIENT = 11 ;
16+
SERVER = 12 ;
17+
RADIO = 13 ;
18+
DISH = 14 ;
19+
REQ = 15 ;
20+
REP = 16 ;
21+
}
22+
23+
// ZeroMQ Protocols
24+
25+
enum ZMQProtocolType {
26+
UNKNOWN = 0 ;
27+
TCP = 1 ;
28+
IPC = 2 ;
29+
INPROC = 3 ;
30+
PGM = 4 ;
31+
VMCI = 5 ;
32+
UDP = 6 ;
33+
}
34+
35+
// ZeroMQ Security Scheme
36+
37+
enum ZMQSecurityScheme {
38+
NULL = 0 ;
39+
PLAIN = 1 ;
40+
CURVE = 2 ;
41+
GSSAPI = 3 ;
42+
}
43+

‎rfc/5/FBLP.rst‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
:status: raw
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

11-
Firebird Butler Log Protocol (FBLP) is designed for unified creation, processing, and exchange of log information within Firebird Butler system.
11+
Firebird Butler Log Protocol (FBLP) is designed for unified creation, processing, and
12+
exchange of log information within Firebird Butler system.
1213

1314
License
1415
=======
@@ -17,21 +18,27 @@ Copyright (c) 2018 The Firebird Butler Project.
1718

1819
This Specification is distributed under Creative Commons Attribution-ShareAlike 4.0 International license.
1920

20-
You should have received a copy of the CC BY-SA 4.0 along with this document; if not, see https://creativecommons.org/licenses/by-sa/4.0/
21+
You should have received a copy of the CC BY-SA 4.0 along with this document; if not,
22+
see https://creativecommons.org/licenses/by-sa/4.0/
2123

2224
Change Process
2325
==============
2426

25-
This Specification is a free and open standard and is governed by the Consensus-Oriented Specification System (COSS) (see "|COSS-long|").
27+
This Specification is a free and open standard and is governed by the Consensus-Oriented
28+
Specification System (COSS) (see "|COSS-long|").
2629

2730
.. important::
2831

29-
This specification is still incomplete (work in progress), hence the COSS change process is not yet fully applicable. All ideas and change proposals SHOULD be presented and discussed in `Firebird Butler forum <https://groups.google.com/d/forum/firebird-butler>`_.
32+
This specification is still incomplete (work in progress), hence the COSS change process
33+
is not yet fully applicable. All ideas and change proposals SHOULD be presented and
34+
discussed in `Firebird Butler forum <https://groups.google.com/d/forum/firebird-butler>`_.
3035

3136
Language
3237
========
3338

34-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in `RFC2119`_.
39+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
40+
"RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described
41+
in `RFC2119`_.
3542

3643
Related Specifications
3744
======================
@@ -45,17 +52,21 @@ Related Specifications
4552
1. Goals
4653
========
4754

48-
The purpose of this specification is to define unified log format, and formal rules for exchanging log messages between Butler Service and its Client. Its goals are:
55+
The purpose of this specification is to define unified log format, and formal rules for
56+
exchanging log messages between Butler Service and its Client. Its goals are:
4957

50-
#. Define unified, flexible and extensible data format for logging information, suitable for diagnostic and audit purposes.
51-
#. Define serialization format for such logging information suitable for transmission in |FBSP| `Data Frames`.
58+
#. Define unified, flexible and extensible data format for logging information, suitable
59+
for diagnostic and audit purposes.
60+
#. Define serialization format for such logging information suitable for transmission in
61+
|FBSP| `Data Frames`.
5262
#. Define the method of publishing log information through ZeroMQ_ PUB_ sockets.
53-
#. Define a single API for forwarding log information between the :doc:`Firebird Butler Service </rfc/3/FBSD>` and the `Client`.
63+
#. Define a single API for forwarding log information between
64+
the :doc:`Firebird Butler Service </rfc/3/FBSD>` and the `Client`.
5465

5566
2. Implementation
5667
=================
5768

58-
.. todo::
69+
.. todo::
5970
:class: todo
6071

6172
Specification body.

‎rfc/6/SSTP.rst‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
:status: raw
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

11-
Service State Protocol (SSTP) is designed for unified creation, processing, and exchange of Service state information within Firebird Butler system.
11+
Service State Protocol (SSTP) is designed for unified creation, processing, and exchange
12+
of Service state information within Firebird Butler system.
1213

1314
License
1415
=======
@@ -17,21 +18,27 @@ Copyright (c) 2018 The Firebird Butler Project.
1718

1819
This Specification is distributed under Creative Commons Attribution-ShareAlike 4.0 International license.
1920

20-
You should have received a copy of the CC BY-SA 4.0 along with this document; if not, see https://creativecommons.org/licenses/by-sa/4.0/
21+
You should have received a copy of the CC BY-SA 4.0 along with this document; if not,
22+
see https://creativecommons.org/licenses/by-sa/4.0/
2123

2224
Change Process
2325
==============
2426

25-
This Specification is a free and open standard and is governed by the Consensus-Oriented Specification System (COSS) (see "|COSS-long|").
27+
This Specification is a free and open standard and is governed by the Consensus-Oriented
28+
Specification System (COSS) (see "|COSS-long|").
2629

2730
.. important::
2831

29-
This specification is still incomplete (work in progress), hence the COSS change process is not yet fully applicable. All ideas and change proposals SHOULD be presented and discussed in `Firebird Butler forum <https://groups.google.com/d/forum/firebird-butler>`_.
32+
This specification is still incomplete (work in progress), hence the COSS change process
33+
is not yet fully applicable. All ideas and change proposals SHOULD be presented and
34+
discussed in `Firebird Butler forum <https://groups.google.com/d/forum/firebird-butler>`_.
3035

3136
Language
3237
========
3338

34-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in `RFC2119`_.
39+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
40+
"RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described
41+
in `RFC2119`_.
3542

3643
Related Specifications
3744
======================
@@ -45,18 +52,22 @@ Related Specifications
4552
1. Goals
4653
========
4754

48-
The purpose of this specification is to define unified data format, and formal rules for exchanging state information between Butler Service and its Client. Its goals are:
55+
The purpose of this specification is to define unified data format, and formal rules for
56+
exchanging state information between Butler Service and its Client. Its goals are:
4957

50-
#. Define unified, flexible and extensible data format for `Service` and `Connection` state information, suitable for diagnostic and control purposes.
51-
#. Define serialization format for such state information suitable for transmission in |FBSP| `Data Frames`.
58+
#. Define unified, flexible and extensible data format for `Service` and `Connection` state
59+
information, suitable for diagnostic and control purposes.
60+
#. Define serialization format for such state information suitable for transmission in
61+
|FBSP| `Data Frames`.
5262
#. Define the method of publishing such state information through ZeroMQ_ PUB_ sockets.
53-
#. Define a base API for transmitting such state information between the :doc:`Firebird Butler Service </rfc/3/FBSD>` and the `Client`.
63+
#. Define a base API for transmitting such state information between the
64+
:doc:`Firebird Butler Service </rfc/3/FBSD>` and the `Client`.
5465
#. Define a base API for changing the `Service` and `Connection` state by the `Client`.
5566

5667
2. Implementation
5768
=================
5869

59-
.. todo::
70+
.. todo::
6071
:class: todo
6172

6273
Specification body.

‎rfc/7/RSCFG.rst‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
:status: raw
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

11-
Remote Service Configuration Protocol (RSCFG) specifies a uniform method for configuring Firebird Butler Service operating parameters through Client requests passed via |FBSP| protocol.
11+
Remote Service Configuration Protocol (RSCFG) specifies a uniform method for configuring
12+
Firebird Butler Service operating parameters through Client requests passed via |FBSP| protocol.
1213

1314
License
1415
=======
@@ -17,21 +18,27 @@ Copyright (c) 2018 The Firebird Butler Project.
1718

1819
This Specification is distributed under Creative Commons Attribution-ShareAlike 4.0 International license.
1920

20-
You should have received a copy of the CC BY-SA 4.0 along with this document; if not, see https://creativecommons.org/licenses/by-sa/4.0/
21+
You should have received a copy of the CC BY-SA 4.0 along with this document; if not,
22+
see https://creativecommons.org/licenses/by-sa/4.0/
2123

2224
Change Process
2325
==============
2426

25-
This Specification is a free and open standard and is governed by the Consensus-Oriented Specification System (COSS) (see "|COSS-long|").
27+
This Specification is a free and open standard and is governed by the Consensus-Oriented
28+
Specification System (COSS) (see "|COSS-long|").
2629

2730
.. important::
2831

29-
This specification is still incomplete (work in progress), hence the COSS change process is not yet fully applicable. All ideas and change proposals SHOULD be presented and discussed in `Firebird Butler forum <https://groups.google.com/d/forum/firebird-butler>`_.
32+
This specification is still incomplete (work in progress), hence the COSS change process
33+
is not yet fully applicable. All ideas and change proposals SHOULD be presented and
34+
discussed in `Firebird Butler forum <https://groups.google.com/d/forum/firebird-butler>`_.
3035

3136
Language
3237
========
3338

34-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in `RFC2119`_.
39+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
40+
"RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described
41+
in `RFC2119`_.
3542

3643
Related Specifications
3744
======================
@@ -45,17 +52,21 @@ Related Specifications
4552
1. Goals
4653
========
4754

48-
The purpose of this specification is to define unified data format, and formal rules for exchanging configuration information between Butler Service and its Client. Its goals are:
55+
The purpose of this specification is to define unified data format, and formal rules for
56+
exchanging configuration information between Butler Service and its Client. Its goals are:
4957

50-
#. Define unified, flexible and extensible data format for `Service` configuration information, suitable for diagnostic and control purposes.
51-
#. Define serialization format for such configuration information suitable for transmission in |FBSP| `Data Frames`.
52-
#. Define a base API for transmitting such configuration information between the :doc:`Firebird Butler Service </rfc/3/FBSD>` and the `Client`.
58+
#. Define unified, flexible and extensible data format for `Service` configuration
59+
information, suitable for diagnostic and control purposes.
60+
#. Define serialization format for such configuration information suitable for transmission
61+
in |FBSP| `Data Frames`.
62+
#. Define a base API for transmitting such configuration information between
63+
the :doc:`Firebird Butler Service </rfc/3/FBSD>` and the `Client`.
5364
#. Define a base API for remote `Service` configuration by its `Client`.
5465

5566
2. Implementation
5667
=================
5768

58-
.. todo::
69+
.. todo::
5970
:class: todo
6071

6172
Specification body.

0 commit comments

Comments
 (0)