Merge branch 'latest' into gh-2628-foreign-keys

Author: p7nov

.github/workflows/deploy-branch.yml

@@ -5,7 +5,7 @@ on:
 jobs:
   deploy-branch:
     runs-on: ubuntu-latest
-    container: tarantool/doc-builder:fat-4
+    container: tarantool/doc-builder:fat-4.1
     env:
       AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
       AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

.github/workflows/deploy-custom.yml

@@ -31,7 +31,7 @@ on:
 jobs:
   custom-deploy-branch:
     runs-on: ubuntu-latest
-    container: tarantool/doc-builder:fat-4
+    container: tarantool/doc-builder:fat-4.1
     env:
       AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
       AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

.github/workflows/main.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-latest
-    container: tarantool/doc-builder:fat-4
+    container: tarantool/doc-builder:fat-4.1
     env:
       AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
       AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

.github/workflows/pull-translation.yml

@@ -13,7 +13,7 @@ on:
 jobs:
   pull-translations:
     runs-on: ubuntu-latest
-    container: tarantool/doc-builder:fat-4
+    container: tarantool/doc-builder:fat-4.1
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/push-translation.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   push-translation-sources:
     runs-on: ubuntu-latest
-    container: tarantool/doc-builder:fat-4
+    container: tarantool/doc-builder:fat-4.1
     steps:
       - uses: actions/checkout@v2
 
@@ -47,4 +47,4 @@ jobs:
           token: ${{secrets.GITHUB_TOKEN}}
           status: ${{job.status}}
           deployment_id: ${{steps.translation.outputs.deployment_id}}
-          env_url: https://crowdin.com/project/tarantool-docs/ru#/${{env.BRANCH_NAME}}
+          env_url: https://crowdin.com/project/tarantool-docs/ru#/${{env.BRANCH_NAME}}

.github/workflows/update-pot.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   update-translations:
     runs-on: ubuntu-latest
-    container: tarantool/doc-builder:fat-4
+    container: tarantool/doc-builder:fat-4.1
 
     steps:
 

README.rst

@@ -18,13 +18,13 @@ First of all, pull the image for building the docs.
 
 ..  code-block:: bash
 
-    docker pull tarantool/doc-builder:fat-4
+    docker pull tarantool/doc-builder:fat-4.1
 
 Next, initialize a Makefile for your OS:
 
 ..  code-block:: bash
 
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "cmake ."
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "cmake ."
 
 Update submodules and generate documentation sources from code
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,13 +61,13 @@ To include their latest contents in the docs, run these two steps.
 
     ..  code-block:: bash
 
-        docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make pull-modules"
+        docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make pull-modules"
 
 2.  Build the submodules content:
 
     ..  code-block:: bash
 
-        docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make build-modules"
+        docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make build-modules"
 
     This command will do two things:
 
@@ -89,7 +89,7 @@ and refresh the browser page.
 
 ..  code-block:: bash
 
-    docker run --rm -it -p 8000:8000 -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make autobuild"
+    docker run --rm -it -p 8000:8000 -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make autobuild"
 
 First build will take some time.
 When it's done, open `127.0.0.1:8000 <http://127.0.0.1:8000>`_ in the browser.
@@ -101,8 +101,8 @@ and then serve them using python3 built-in server:
 
 ..  code-block:: bash
 
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html-ru"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html-ru"
     python3 -m http.server --directory output/html
 
 or python2 built-in server:
@@ -119,17 +119,17 @@ in the ``tarantool/doc-builder`` container:
 
 ..  code-block:: bash
 
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html-ru"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make singlehtml"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make singlehtml-ru"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make pdf"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make pdf-ru"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make json"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make json-ru"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make epub"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make epub-ru"
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make update-po"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html-ru"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make singlehtml"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make singlehtml-ru"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make pdf"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make pdf-ru"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make json"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make json-ru"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make epub"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make epub-ru"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make update-po"
 
 Linkcheck
 ---------
@@ -138,13 +138,13 @@ There's a specific build mode which checks internal and external links instead o
 
 ..  code-block:: bash
 
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make linkcheck"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make linkcheck"
 
 If you need to save the linkcheck's report in a file, you can use the following trick:
 
 ..  code-block:: bash
 
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make linkcheck" 2>&1 | tee linkcheck.log
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make linkcheck" 2>&1 | tee linkcheck.log
 
 Here ``2>&1`` redirects the ``stderr`` output to ``stdout``, and then ``tee`` both
 shows in on screen and writes to a file.
@@ -167,7 +167,7 @@ To update the translation files, run the `make update-po` task:
 
 ..  code-block:: bash
 
-    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make update-po"
+    docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make update-po"
 
 Translate the strings in the updated files and then commit the changes.
 

doc/book/box/atomic/atomic-cooperative_multitasking.rst renamed to doc/book/app_server/cooperative_multitasking.rst

@@ -1,28 +1,29 @@
-..  _atomic-cooperative_multitasking:
-
-Cooperative multitasking
-========================
-
-Cooperative multitasking means that unless a running fiber deliberately yields
-control, it is not preempted by some other fiber. But a running fiber will
-deliberately yield when it encounters a “yield point”: a transaction commit,
-an operating system call, or an explicit :ref:`"yield" <fiber-yield>` request.
-Any system call which can block will be performed asynchronously, and any running
-fiber which must wait for a system call will be preempted, so that another
-ready-to-run fiber takes its place and becomes the new running fiber.
-
-This model makes all programmatic locks unnecessary: cooperative multitasking
-ensures that there will be no concurrency around a resource, no race conditions,
-and no memory consistency issues. The way to achieve this is simple:
-Use no yields, explicit or implicit in critical sections, and no one can 
-interfere with code execution.
-
-When dealing with small requests, such as simple UPDATE or INSERT or DELETE or 
-SELECT, fiber scheduling is fair: it takes only a little time to process the 
-request, schedule a disk write, and yield to a fiber serving the next client.
-
-However, a function may perform complex computations or be written in
-such a way that yields take a long time to occur. This can lead to
-unfair scheduling when a single client throttles the rest of the system, or to
-apparent stalls in request processing. Avoiding this situation is
-the responsibility of the function’s author.
+..  _app-cooperative_multitasking:
+
+Cooperative multitasking
+========================
+
+Cooperative multitasking means that unless a running fiber deliberately yields
+control, it is not preempted by some other fiber. But a running fiber will
+deliberately yield when it encounters a “yield point”: a transaction commit,
+an operating system call, or an explicit :ref:`"yield" <fiber-yield>` request.
+Any system call which can block will be performed asynchronously, and any running
+fiber which must wait for a system call will be preempted, so that another
+ready-to-run fiber takes its place and becomes the new running fiber.
+
+This model makes all programmatic locks unnecessary: cooperative multitasking
+ensures that there will be no concurrency around a resource, no race conditions,
+and no memory consistency issues. The way to achieve this is simple:
+Use no yields, explicit or implicit in critical sections, and no one can 
+interfere with code execution.
+
+For small requests, such as simple UPDATE or INSERT or DELETE or 
+SELECT, fiber scheduling is fair: it takes little time to process the 
+request, schedule a disk write, and yield to a fiber serving the next client.
+
+However, a function may perform complex calculations or be written in
+such a way that yields take a long time to occur. This can lead to
+unfair scheduling when a single client throttles the rest of the system, or to
+apparent stalls in processing requests. It is the responsibility of the function 
+author to avoid this situation.
+

doc/book/app_server/index.rst

@@ -21,6 +21,8 @@ This chapter contains the following sections:
    installing_module
    contributing_module
    reloading_module
+   yields
+   cooperative_multitasking
    luajit_memprof
    luajit_getmetrics
    using_ide