Skip to content
Snippets Groups Projects
Commit fc92eb6c authored by ocelot-inc's avatar ocelot-inc
Browse files

fix for warnings emitted by make

parent 59494929
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
doc/sphinx/book/administration.rst
+ 13
− 13
View file @ fc92eb6c
......@@ -262,32 +262,32 @@ The settings in the above script are:
commands for tarantoolctl
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The command format is ``tarantoolctl operation application-name``, where
The command format is :samp:`tarantoolctl operation {application_name}`, where
operation is one of: start, stop, enter, logrotate, status, reload. Thus ...
.. option:: start <app_name>
.. option:: start <application_name>
starts application <app_name>
starts application <application_name>
.. option:: stop <app_name>
.. option:: stop <application_name>
stops <app_name>
stops <application_name>
.. option:: enter <app_name>
.. option:: enter <application_name>
shows <app_name>'s admin console, if it has one
shows <application_name>'s admin console, if it has one
.. option:: logrotate <app_name>
.. option:: logrotate <application_name>
rotates <app_name>'s log files (make new, remove old)
rotates <application_name>'s log files (make new, remove old)
.. option:: status <app_name>
.. option:: status <application_name>
checks <app_name>'s status
checks <application_name>'s status
.. option:: reload <file_name>
.. option:: reload <application_name> <file_name>
reloads <file_name>.
load and execute the code from <file_name> as an instance of <application_name>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
typical code snippets for tarantoolctl
......
doc/sphinx/book/box/box_index.rst
+ 4
− 4
View file @ fc92eb6c
......@@ -519,9 +519,9 @@ API is a direct binding to corresponding methods of index objects of type
:return: number of bytes
:rtype: number
===========================================================
=================================================================
Example showing use of the box functions
===========================================================
=================================================================
This example will work with the sandbox configuration described in the preface.
That is, there is a space named tester with a numeric primary key. The example
......@@ -592,9 +592,9 @@ Lua functions `os.date()`_ and `string.sub()`_.
.. _RTREE:
===========================================================
=============================================================================
Package `box.index` with index type = RTREE for spatial searches
===========================================================
=============================================================================
The :mod:`box.index` package may be used for spatial searches if the index type
is RTREE. There are operations for searching ``rectangles``. Rectangles are
......
doc/sphinx/book/box/box_introspection.rst
+ 2
− 2
View file @ fc92eb6c
-------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Packages box.cfg, box.info, box.slab, and box.stat: server introspection
-------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
=====================================================================
Package `box.cfg`
......
doc/sphinx/book/box/box_space.rst
+ 2
− 2
View file @ fc92eb6c
......@@ -789,9 +789,9 @@ A list of all ``box.space`` functions follows, then comes a list of all
``_cluster`` is a new system tuple set
for support of the :ref:`replication feature <box-replication>`.
=================================================
===================================================================
Example showing use of the box.space functions
=================================================
===================================================================
This function will illustrate how to look at all the spaces, and for each
display: approximately how many tuples it contains, and the first field of
......
doc/sphinx/reference/digest.rst
+ 35
− 32
View file @ fc92eb6c
......@@ -11,59 +11,60 @@ The functions in digest are:
.. module:: digest
.. _sha
.. _sha:
.. _sha_hex:
.. _sha1:
.. _sha1_hex:
.. _sha224:
.. _sha224_hex:
.. _sha256:
.. _sha256_hex:
.. _sha384:
.. _sha384_hex:
.. _sha512:
.. _sha512_hex:
.. _md4_in_digest:
.. _md4_hex:
.. _md5_in_digest:
.. _md5_hex:
.. _crc32_in_digest:
.. _crc32_update:
.. _crc32_new:
.. _base64_encode:
.. _base64_decode:
.. _urandom:
.. _guava_in_digest:
.. _murmur_in_digest:
.. _murmur_new:
| :samp:`sha({string})` Returns 160-bit digest made with SHA-0. Not recommended.
.. _sha_hex
| :samp:`sha_hex({string})` Returns hexadecimal of a digest calculated with sha.
.. _sha1
| :samp:`sha1({string})` Returns 160-bit digest made with SHA-1.
.. _sha1_hex
| :samp:`sha1_hex({string})` Returns hexadecimal of a digest calculated with sha1.
.. _sha224
| :samp:`sha224({string})` Returns 224-bit digest made with SHA-2.
.. _sha224_hex
| :samp:`sha224_hex({string})` Returns hexadecimal of a digest calculated with sha224.
.. _sha256
| :samp:`sha256({string})` Returns 256-bit digest made with SHA-2.
.. _sha256_hex
| :samp:`sha256_hex({string})` Returns hexadecimal of a digest calculated with sha256.
.. _sha384
| :samp:`sha384({string})` Returns 384-bit digest made with SHA-2.
.. _sha384_hex
| :samp:`sha384_hex({string})` Returns hexadecimal of a digest calculated with sha384.
.. _sha512
| :samp:`sha512({string})` Returns 512-bit digest made with SHA-2.
.. _sha512_hex
| :samp:`sha512_hex({string})` Returns hexadecimal of a digest calculated with sha512.
.. _md4
| :samp:`md4({string})` Returns 128-bit digest made with MD4.
.. _md4_hex
| :samp:`md4_hex({string})` Returns hexadecimal of a digest calculated with md4.
.. _md5
| :samp:`md5({string})` Returns 256-bit digest made with MD5.
.. _md5_hex
| :samp:`md5_hex({string})` Returns hexadecimal of a digest calculated with md5.
.. _crc32
| :samp:`crc32({string})` Returns 32-bit checksum made with CRC32. See `crc32 notes <crc32 notes>`_.
.. _crc32_update
| :samp:`crc32_update({number, string})` Returns update of a checksum calculated with CRC32. See `crc32 notes <crc32 notes>`_.
.. _crc32_new
| :samp:`crc32.new()` Initiates incremental crc32. See `incremental digest <incremental digest>`_.
.. _base64_encode
| :samp:`crc32({string})` Returns 32-bit checksum made with CRC32. See :ref:`crc32 notes <crc32notes>`.
| :samp:`crc32_update({number, string})` Returns update of a checksum calculated with CRC32. See :ref:`crc32 notes <crc32notes>`.
| :samp:`crc32.new()` Initiates incremental crc32. See :ref:`incremental digests <incremental digests>`.
| :samp:`base64_encode({string})` Returns base64 encoding from a regular string.
.. _base64_decode
| :samp:`base64_decode({string})` Returns a regular string from a base64 encoding.
.. _urandom
| :samp:`urandom({integer})` Returns array of random bytes with length = integer.
.. _guava
| :samp:`guava({integer}, {integer})` Returns a number made with consistent hash. See `guava notes <guava notes>`_.
.. _murmur
| :samp:`guava({integer}, {integer})` Returns a number made with consistent hash. See :ref:`guava notes <guavanotes>`.
| :samp:`murmur({string})` Returns 32-bit digest made with MurmurHash.
.. _murmur_new
| :samp:`murmur.new([{seed}])` Initiates incremental MurmurHash. See `incremental digest <incremental digest>`_.
| :samp:`murmur.new([{seed}])` Initiates incremental MurmurHash. See :ref:`incremental digests <incremental digests>`.
.. _crc32notes:
.. _crc32 notes:
**crc32 notes**
The crc32 and crc32_update function use the `CRC-32C (Castagnoli)`_ polynomial
value: 0x11EDC6F41 / 4812730177. If it is necessary to be
......@@ -81,7 +82,8 @@ The functions in digest are:
.. _CRC-32C (Castagnoli): https://en.wikipedia.org/wiki/Cyclic_redundancy_check#Standards_and_common_use
.. _guava notes:
.. _guavanotes:
**guava notes**
The guava function uses the `Consistent Hashing`_ algorithm of
......@@ -96,6 +98,7 @@ The functions in digest are:
8
.. _incremental digests:
**incremental digests**
Suppose that a digest is done for a string 'A',
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment