Skip to content

Commit a9216cf

Browse files
committed
Update documentation about CMS internals.
1 parent 962f1d7 commit a9216cf

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

docs/Internals.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
Internals
22
*********
33

4-
This section contains some details about some CMS internals. They're
5-
mostly meant for developers, not for users. However, if you're curious
6-
about what's under the hood, you'll find something interesting here
4+
This section contains some details about some CMS internals. They are
5+
mostly meant for developers, not for users. However, if you are curious
6+
about what's under the hood, you will find something interesting here
77
(though without any pretension of completeness). Moreover, these are
88
not meant to be full specifications, but only useful notes for the
99
future.
1010

11+
Oh, I was nearly forgetting: if you are curious about what happens
12+
inside CMS, you may actually be interested in helping us writing
13+
it. We can assure you it is a very rewarding task. After all, if you
14+
are hanging around here, you must have some interest in coding! In
15+
case, feel free `to get in touch with us
16+
<http://cms-dev.github.io/>`_.
17+
1118
RPC protocol
1219
============
1320

@@ -19,7 +26,8 @@ cannot be used in the JSON encoding: this is not a problem, since new
1926
lines inside string represented in the JSON have to be escaped
2027
anyway).
2128

22-
An RPC request must be of the form::
29+
An RPC request must be of the form (it is pretty printed here, but it
30+
is sent in compact form inside CMS)::
2331

2432
{
2533
"__method": <name of the requested method>,
@@ -63,7 +71,7 @@ terminator.
6371
Backdoor
6472
========
6573

66-
Setting the `backdoor` configuration key to true causes services to
74+
Setting the ``backdoor`` configuration key to true causes services to
6775
serve a Python console (accessible with netcat), running in the same
6876
interpreter instance as the service, allowing to inspect and modify its
6977
data, live. It will be bound to a local UNIX domain socket, usually at

0 commit comments

Comments
 (0)