Skip to content

Commit b12a534

Browse files
committed
Revert "restoring after an undesirable edit"
This reverts commit 95b344e.
1 parent 4d7f8e7 commit b12a534

File tree

6 files changed

+77
-47
lines changed

6 files changed

+77
-47
lines changed

sphinx/book/box/authentication.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,12 @@ several years ago`_ which has proved adequate for medium-security installations.
3838
Nevertheless administrators should warn users that no system is foolproof against
3939
determined long-term attacks, so passwords should be guarded and changed occasionally.
4040

41-
Notes: To get the hash-password of a string 'X', say ``box.schema.user.password('X')``.
42-
To see more about the details of the algorithm for the purpose of writing a new
43-
client application, read the `scramble.h`_ header file.
41+
.. NOTE::
42+
43+
To get the hash-password of a string 'X', say
44+
``box.schema.user.password('X')``. To see more about the details of the
45+
algorithm for the purpose of writing a new client application, read the
46+
`scramble.h`_ header file.
4447

4548
.. _Cryptographic hash function: https://en.wikipedia.org/wiki/Cryptographic_hash
4649
.. _Salt Value: https://en.wikipedia.org/wiki/Salt_%28cryptography%29

sphinx/book/box/box_space.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -804,16 +804,20 @@ A list of all ``box.space`` functions follows, then comes a list of all
804804

805805
.. method:: truncate()
806806

807-
Deletes all tuples. Note that ``truncate`` must be called only by the
808-
user who created the space OR under a `setuid` function created by that
809-
user. Read more about `setuid` functions :ref:`here <authentication-funcs>`.
807+
Deletes all tuples. .
810808

811809
Parameters: :samp:`{space_object}` = an :ref:`object reference <index-object_reference>`.
812810

813811
**Complexity Factors:** Index size, Index type, Number of tuples accessed.
814812

815813
:return: nil
816814

815+
.. NOTE::
816+
817+
Note that ``truncate`` must be called only by the user who created
818+
the space OR under a `setuid` function created by that user. Read
819+
more about `setuid` functions :ref:`here <authentication-funcs>`
820+
817821
Note re storage engine: vinyl does not support ``truncate()``.
818822

819823
**Example:**

sphinx/book/box/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,10 @@ the tuple that was just updated.
319319
Note re storage engine: vinyl handles yields differently, see
320320
:ref:`differences between memtx and vinyl <vinyl_diff>`.
321321

322-
Note re multi-request transactions: there is a way to delay yields,
323-
see :ref:`Atomic execution <atomic-atomic_execution>`.
322+
.. NOTE:: Note re multi-request transactions
323+
324+
there is a way to delay yields, see
325+
:ref:`Atomic execution <atomic-atomic_execution>`.
324326

325327
Since locks don't exist, and disk writes only involve the write-ahead log,
326328
transactions are usually fast. Also the Tarantool server may not be using up all

sphinx/book/configuration/cfg_basic.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,10 @@
5454
A typical value is 3301. The listen parameter may also be set for
5555
:ref:`local hot standby <book_cfg_local_hot_standby>`.
5656

57-
NOTE: A replica also binds to this port, and accepts connections, but these
58-
connections can only serve reads until the replica becomes a master.
57+
.. NOTE::
58+
59+
A replica also binds to this port, and accepts connections, but these
60+
connections can only serve reads until the replica becomes a master.
5961

6062
Type: integer or string |br|
6163
Default: null |br|

sphinx/book/replication/index.rst

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,21 +65,27 @@ file and the WAL .xlog files), then starting replication again - the replica
6565
will then catch up with the master by retrieving all the master's tuples.
6666
Again, this procedure works only if the master's WAL files are present.
6767

68-
NOTE:
69-
Replication parameters are "dynamic", which allows the replica to become
70-
a master and vice versa with the help of the :ref:`box.cfg <box_introspection-box_cfg>` statement.
71-
72-
NOTE:
73-
The replica does not inherit the master's configuration parameters, such
74-
as the ones that cause the :ref:`snapshot daemon <book_cfg_snapshot_daemon>` to run on the master.
75-
To get the same behavior, one would have to set the relevant parameters explicitly
76-
so that they are the same on both master and replica.
77-
78-
NOTE:
79-
Replication requires privileges. Privileges for accessing spaces could be granted directly
80-
to the user who will start the replica. However, it is more usual to
81-
grant privileges for accessing spaces to a :ref:`role <authentication-rep_role>`, and then grant the
82-
role to the user who will start the replica.
68+
.. NOTE::
69+
70+
Replication parameters are "dynamic", which allows the replica to become
71+
a master and vice versa with the help of the
72+
:ref:`box.cfg <box_introspection-box_cfg>` statement.
73+
74+
.. NOTE::
75+
76+
The replica does not inherit the master's configuration parameters, such
77+
as the ones that cause the :ref:`snapshot daemon <book_cfg_snapshot_daemon>`
78+
to run on the master. To get the same behavior, one would have to set the
79+
relevant parameters explicitly so that they are the same on both master and
80+
replica.
81+
82+
.. NOTE::
83+
84+
Replication requires privileges. Privileges for accessing spaces could be
85+
granted directly to the user who will start the replica. However, it is more
86+
usual to grant privileges for accessing spaces to a
87+
:ref:`role <authentication-rep_role>`, and then grant the role to the user
88+
who will start the replica.
8389

8490
=====================================================================
8591
Recovering from a degraded state

sphinx/reference_lua/json.rst

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -137,28 +137,41 @@ Serializing 'A' and 'B' with different ``__serialize`` values causes different r
137137
138138
.. _json-module_cfg:
139139

140-
A NOTE ABOUT CONFIGURATION SETTINGS:
141-
There are configuration settings which affect the way that Tarantool
142-
encodes invalid numbers or types. They are all boolean true/false values. |br|
143-
:code:`cfg.encode_invalid_numbers default = true /* allow nan and inf */` |br|
144-
:code:`cfg.encode_use_tostring default = false /* use tostring for unrecognizable types */` |br|
145-
:code:`cfg.encode_invalid_as_nil default = false /* use null for all unrecognizable types */` |br|
146-
:code:`cfg.encode_load_metatables default = true /* load metatables */` |br|
147-
For example, the following code will interpret 0/0
148-
(which is "not a number") and 1/0 (which is "infinity")
149-
as special values rather than nulls or errors: |br|
150-
:code:`json = require('json')` |br|
151-
:code:`json.cfg{encode_invalid_numbers = true}` |br|
152-
:code:`x = 0/0` |br|
153-
:code:`y = 1/0` |br|
154-
:code:`json.encode({1,x,y,2})` |br|
155-
The result of the json.encode request will look like this: |br|
156-
:code:`tarantool>` :extsamp:`{**{json.encode({1,x,y,2})}**}` |br|
157-
:code:`---` |br|
158-
:code:`- '[1,nan,inf,2]` |br|
159-
:code:`...` |br|
160-
The same configuration settings exist for json, for :ref:`MsgPack <msgpack-module>`, and
161-
for :ref:`yaml <yaml-module>`.
140+
================================================================
141+
Configuration settings
142+
================================================================
143+
144+
There are configuration settings which affect the way that Tarantool encodes
145+
invalid numbers or types. They are all boolean ``true``/``false`` values
146+
147+
* ``cfg.encode_invalid_numbers`` - allow nan and inf (default is true)
148+
* ``cfg.encode_use_tostring`` - use tostring for unrecognizable types (default is false)
149+
* ``cfg.encode_invalid_as_nil`` - use null for all unrecognizable types (default is false)
150+
* ``cfg.encode_load_metatables`` - load metatables (default is false)
151+
152+
For example, the following code will interpret 0/0 (which is "not a number")
153+
and 1/0 (which is "infinity") as special values rather than nulls or errors:
154+
155+
.. code-block:: lua
156+
157+
json = require('json')
158+
json.cfg{encode_invalid_numbers = true}
159+
x = 0/0
160+
y = 1/0
161+
json.encode({1, x, y, 2})
162+
163+
The result of the json.encode request will look like this:
164+
165+
.. code-block:: tarantoolsession
166+
167+
tarantool> json.encode({1, x, y, 2})
168+
---
169+
- '[1,nan,inf,2]
170+
...
171+
172+
The same configuration settings exist for json, for
173+
:ref:`MsgPack <msgpack-module>`, and for :ref:`YAML <yaml-module>`.
174+
>>>>>>> Fix every NOTE to be highlighted on site + JSON cfg rewritten
162175

163176
.. _Lua-CJSON module by Mark Pulford: http://www.kyne.com.au/~mark/software/lua-cjson.php
164177
.. _the official documentation: http://www.kyne.com.au/~mark/software/lua-cjson-manual.html

0 commit comments

Comments
 (0)