diff --git a/doc/developer/CMakeLists.txt b/doc/developer/CMakeLists.txt index b1a35d82130c420b35728732c376e41913cd2c79..3f9b7ba7700a00d36cb07444ba0a129f2743d68b 100644 --- a/doc/developer/CMakeLists.txt +++ b/doc/developer/CMakeLists.txt @@ -2,8 +2,8 @@ if (JING STREQUAL "JING-NOTFOUND") message (FATAL_ERROR "jing is missing") endif() -set(PATH_DEVGUIDE_HTML "${PROJECT_BINARY_DIR}/doc/www/content/docs/dev_guide.html") -set(PATH_DEVGUIDE_HTML_CSS "${PROJECT_BINARY_DIR}/doc/www/content/docs/") +set(PATH_DEVGUIDE_HTML "${PROJECT_BINARY_DIR}/doc/www/content/doc/dev_guide.html") +set(PATH_DEVGUIDE_HTML_CSS "${PROJECT_BINARY_DIR}/doc/www/output/doc/") set(PATH_DEVGUIDE_TXT "${PROJECT_BINARY_DIR}/doc/developer/dev_guide.txt") add_custom_target(doc-check-dev diff --git a/doc/developer/developer.xml b/doc/developer/developer.xml index 79cdc6bc42a77d51c8d8030bcda6afe1c85bb095..3109ae0452893f3e369e69e15d63094750a8dbe9 100644 --- a/doc/developer/developer.xml +++ b/doc/developer/developer.xml @@ -14,7 +14,7 @@ <itemizedlist> <listitem><para>a user guide</para></listitem> <listitem><para>a developer guide (you're reading it)</para></listitem> - <listitem><para>protocol description doc/www/content/docs/box-protocol.rst</para></listitem> + <listitem><para>protocol description doc/www/content/doc/box-protocol.rst</para></listitem> <listitem><para>coding style guides for Lua, Objective C, C, Python (for other connectors, we use conventions of the connector programming language community)</para></listitem> diff --git a/doc/user/CMakeLists.txt b/doc/user/CMakeLists.txt index 5a914d3d990c53dd8e7968da782fb15853251af0..5a6600f3a74d334bfaab85cef1ad11869749f31b 100644 --- a/doc/user/CMakeLists.txt +++ b/doc/user/CMakeLists.txt @@ -1,7 +1,7 @@ -set(PATH_USERGUIDE_HTML "${PROJECT_BINARY_DIR}/doc/www/content/docs/user_guide.html") -set(PATH_USERGUIDE_HTML_CSS "${PROJECT_BINARY_DIR}/doc/www/output/docs/") -set(PATH_USERGUIDE_HTML_CHUNK "${PROJECT_BINARY_DIR}/doc/www/content/docs/user_guide/") -set(PATH_USERGUIDE_HTML_CHUNK_CSS "${PROJECT_BINARY_DIR}/doc/www/output/docs/user_guide/") +set(PATH_USERGUIDE_HTML "${PROJECT_BINARY_DIR}/doc/www/content/doc/user_guide.html") +set(PATH_USERGUIDE_HTML_CSS "${PROJECT_BINARY_DIR}/doc/www/output/doc/") +set(PATH_USERGUIDE_HTML_CHUNK "${PROJECT_BINARY_DIR}/doc/www/content/doc/user_guide/") +set(PATH_USERGUIDE_HTML_CHUNK_CSS "${PROJECT_BINARY_DIR}/doc/www/output/doc/user_guide/") set(PATH_USERGUIDE_TXT "${PROJECT_BINARY_DIR}/doc/user/tarantool_user_guide.txt") if (XMLLINT STREQUAL "XMLLINT-NOTFOUND") diff --git a/doc/user/connectors.xml b/doc/user/connectors.xml index 28ea2f8ab521e31de4fd76259dc531ec15a70a91..1cbdd17808398521943715be5289c55189e2b425 100644 --- a/doc/user/connectors.xml +++ b/doc/user/connectors.xml @@ -37,7 +37,7 @@ A complete description of the binary protocol is maintained in annotated Backus-Naur form in the source tree: please see - <link xlink:href="http://tarantool.org/docs/box-protocol.html"><filename>docs/box-protocol.html</filename></link>. + <link xlink:href="http://tarantool.org/doc/box-protocol.html"><filename>doc/box-protocol.html</filename></link>. </para> </section> @@ -47,7 +47,7 @@ The Tarantool API exists so that a client program can send a request packet to the server, and receive a response. Here is an example of a what the client would send for <command>box.space[513]:insert{'A', 'BB'}</command>. The BNF description of the components -is in file <link xlink:href="http://tarantool.org/docs/box-protocol.html" xlink:title="A complete BNF of Tarantool client/server protocol">docs/box-protocol.html</link>. +is in file <link xlink:href="http://tarantool.org/doc/box-protocol.html" xlink:title="A complete BNF of Tarantool client/server protocol">doc/box-protocol.html</link>. A third-party contribution written in Lua for unpacking Tarantool messages is in file <link xlink:href="https://github.com/negram/Tnt-dissector/blob/master/tarantool.dis.lua" xlink:title="tarantool.dis.lua">Tnt-dissector</link>. @@ -124,7 +124,7 @@ is in file <link xlink:href="http://tarantool.org/docs/box-protocol.html" xlink: </informaltable> <para> Now, one could send that packet to the tarantool server, -and interpret the response (docs/box-protocol.html has a description +and interpret the response (doc/box-protocol.html has a description of the packet format for responses as well as requests). But it would be easier, and less error-prone, if one could invoke a routine that formats the packet according to typed diff --git a/doc/user/data-model.xml b/doc/user/data-model.xml index 7840cd775a097c504aac08d55b6088684c3cdc27..e885a88a9563cc5d5dc6e01abb5652ff8c5cefa0 100644 --- a/doc/user/data-model.xml +++ b/doc/user/data-model.xml @@ -333,7 +333,7 @@ server on the same processor without ill effects. programming language connector</olink>. The client/server protocol is open and documented: an annotated BNF can be found in the source tree, file <filename - xlink:href="http://tarantool.org/docs/box-protocol.html" xlink:title="A complete BNF of Tarantool client/server protocol">doc/box-protocol.html</filename>. + xlink:href="http://tarantool.org/doc/box-protocol.html" xlink:title="A complete BNF of Tarantool client/server protocol">doc/box-protocol.html</filename>. </para> </section> diff --git a/doc/user/language-reference.xml b/doc/user/language-reference.xml index 3e5c15a73e80fe847994edd4ab408288eab2bd07..067317b8eb8f4d1b472ed5f1b992fa1691a2daf3 100644 --- a/doc/user/language-reference.xml +++ b/doc/user/language-reference.xml @@ -18,7 +18,7 @@ <itemizedlist> <listitem><para> Primary port. This port is for handling requests in the - <link xlink:href="http://tarantool.org/docs/box-protocol.html" xlink:title="A complete BNF of Tarantool client/server protocol">native Tarantool protocol</link> + <link xlink:href="http://tarantool.org/doc/box-protocol.html" xlink:title="A complete BNF of Tarantool client/server protocol">native Tarantool protocol</link> (also called the "binary protocol"), and provides full data access. </para> <para> @@ -99,7 +99,7 @@ A complete description of the binary protocol is maintained in annotated Backus-Naur form in the source tree: please see - <link xlink:href="http://tarantool.org/docs/box-protocol.html"><filename>doc/box-protocol.html</filename></link>. + <link xlink:href="http://tarantool.org/doc/box-protocol.html"><filename>doc/box-protocol.html</filename></link>. </para> </section> diff --git a/doc/user/persistence-architecture.xml b/doc/user/persistence-architecture.xml index 3c0993fbab7b44f82bb9ab092960eeb02d07761e..f5c7a71d3054e73fa1ec0103d331cbb06c1d6359 100644 --- a/doc/user/persistence-architecture.xml +++ b/doc/user/persistence-architecture.xml @@ -20,7 +20,7 @@ number of the first record in the file, plus an extension <filename>.xlog</filen <para>Apart from a log sequence number and the data change request (its format is the same as in the binary protocol and is described in <link -xlink:href="http://tarantool.org/docs/box-protocol.html"><filename>docs/box-protocol.html</filename></link>), +xlink:href="http://tarantool.org/doc/box-protocol.html"><filename>doc/box-protocol.html</filename></link>), each WAL record contains a header, some metadata, and then the data formatted according to <link xlink:href="https://github.com/msgpack/msgpack/blob/master/spec.md">msgpack rules</link>. For example this is what the WAL file looks like after the first INSERT diff --git a/doc/user/server-administration.xml b/doc/user/server-administration.xml index 74a42b4de9ac6137b80b7e162da123d2d828dc70..9a11329f1d48b50b9883635cb4a13d319d28003b 100644 --- a/doc/user/server-administration.xml +++ b/doc/user/server-administration.xml @@ -146,7 +146,7 @@ console.delimiter('')!</programlisting> <para> For a condensed Backus-Naur Form [BNF] description of the suggested form of client requests, see - <link xlink:href="http://tarantool.org/docs/box-protocol.html"><filename>docs/box-protocol.html</filename></link> + <link xlink:href="http://tarantool.org/doc/box-protocol.html"><filename>doc/box-protocol.html</filename></link> and <link xlink:href="https://github.com/tarantool/tarantool/blob/master/doc/sql.txt"><filename>doc/sql.txt</filename></link>. </para> diff --git a/doc/user/tutorial.xml b/doc/user/tutorial.xml index 56d54aa145d67597f8482c71461f79492a9c2f84..7379892b901524a450c1119f6b68edb753f277f3 100644 --- a/doc/user/tutorial.xml +++ b/doc/user/tutorial.xml @@ -701,7 +701,7 @@ inserted and selected tuples. There is a new format (<link xlink:href="https://en.wikipedia.org/wiki/MessagePack">msgpack</link>). Snapshot and WAL files have - <link xlink:href="http://tarantool.org/docs/box-protocol.html">an implementation of the msgpack format</link>; + <link xlink:href="http://tarantool.org/doc/box-protocol.html">an implementation of the msgpack format</link>; incompatible with the old format. Snapshot and WAL files have the same format (snapshots are logs of inserts). </para> diff --git a/doc/www/content/docs/box-protocol.rst b/doc/www/content/doc/box-protocol.rst similarity index 99% rename from doc/www/content/docs/box-protocol.rst rename to doc/www/content/doc/box-protocol.rst index 31717f033c4f6df716c054f32d64be63e2cad1a6..dc3db9027cf94f40a14876b64aa6fa6762621286 100644 --- a/doc/www/content/docs/box-protocol.rst +++ b/doc/www/content/doc/box-protocol.rst @@ -1,7 +1,7 @@ :title: IProto protocol :slug: box-protocol -:save_as: docs/box-protocol.html -:url: docs/box-protocol.html +:save_as: doc/box-protocol.html +:url: doc/box-protocol.html :template: documentation -------------------------------------------------------------------------------- diff --git a/doc/www/content/pages/documentation.rst b/doc/www/content/pages/documentation.rst index e09e7ae2ba139826c6ec69176b610f59ac5294c7..d8c12711507cf9dec6b4b3bafc5a2ee749892351 100644 --- a/doc/www/content/pages/documentation.rst +++ b/doc/www/content/pages/documentation.rst @@ -6,13 +6,13 @@ User Guide: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- `Multi page HTML </docs/user_guide/>`_ -- `Single Page HTML </docs/user_guide.html>`_ +- `Multi page HTML </doc/user_guide/>`_ +- `Single Page HTML </doc/user_guide.html>`_ - `FAQ </faq.html>`_ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Developer section: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- `Developer Guide </docs/dev_guide.html>`_ -- `IProto Protocol </docs/box-protocol.html>`_ +- `Developer Guide </doc/dev_guide.html>`_ +- `IProto Protocol </doc/box-protocol.html>`_ diff --git a/doc/www/pelicanconf.py b/doc/www/pelicanconf.py index b4f73c9308ad1d0822f7dd6edd81b25ae3fb25e8..2e26e9de1eb32fb60080dfb0efe34629c30e12db 100644 --- a/doc/www/pelicanconf.py +++ b/doc/www/pelicanconf.py @@ -25,8 +25,8 @@ TRANSLATION_FEED_ATOM = None DEFAULT_PAGINATION = False -DOCS_PATH = ['docs'] -ARTICLE_EXCLUDES = ['docs'] +DOCS_PATH = ['doc'] +ARTICLE_EXCLUDES = ['doc'] JINJA_FILTERS = { 're_replace': (lambda s, i, o: re.sub(i, o, s)), diff --git a/doc/www/plugins/documentation/documentation.py b/doc/www/plugins/documentation/documentation.py index 59c4517d1362322e9a979ef7aadcb87b5056b201..b3cbc850d888331fd4841ddd38249abad70a9c6c 100644 --- a/doc/www/plugins/documentation/documentation.py +++ b/doc/www/plugins/documentation/documentation.py @@ -26,8 +26,8 @@ class DocumentationContainer(object): class DocumentationGenerator(Generator): def __init__(self, *args, **kwargs): super(DocumentationGenerator, self).__init__(*args, **kwargs) - self.docs_html = [] - self.docs_rst = [] + self.doc_html = [] + self.doc_rst = [] def _doc_read_file(self, relpath, op=False): abspath = os.path.join(self.path, relpath) @@ -59,7 +59,7 @@ class DocumentationGenerator(Generator): if not os.path.isfile(op_abspath): continue page = self._doc_read_file(op_relpath, True) - self.docs_html.append(DocumentationContainer(page)) + self.doc_html.append(DocumentationContainer(page)) if not os.path.isdir(op_abspath[:-5]): continue mp_abspath = os.path.join(op_abspath[:-5], '*.html') @@ -68,7 +68,7 @@ class DocumentationGenerator(Generator): if not os.path.isfile(mp_html_abspath): continue page = self._doc_read_file(mp_html_relpath, False) - self.docs_html[-1].add_mpage(page) + self.doc_html[-1].add_mpage(page) for docpath in self.settings['DOCS_PATH']: abspath = os.path.join(self.path, docpath, '*.rst') for op_abspath in glob.glob(abspath): @@ -87,10 +87,10 @@ class DocumentationGenerator(Generator): if not is_valid_content(page, op_relpath): continue if page: - self.docs_rst.append(DocumentationContainer(page)) + self.doc_rst.append(DocumentationContainer(page)) def generate_output(self, writer): - for doc_cont in self.docs_html: + for doc_cont in self.doc_html: opage = doc_cont.opage writer.write_file( opage.save_as, @@ -105,7 +105,7 @@ class DocumentationGenerator(Generator): self.context, page = mpage, documentation = True) - for doc_cont in self.docs_rst: + for doc_cont in self.doc_rst: opage = doc_cont.opage writer.write_file( opage.save_as, diff --git a/extra/dist/tarantool.init b/extra/dist/tarantool.init index df8f42d9419bb1eeb5d8b70b5b83cc6c19fc4d2e..e51da35e49752baa400357fd3a28c36001c6f02d 100644 --- a/extra/dist/tarantool.init +++ b/extra/dist/tarantool.init @@ -37,7 +37,7 @@ if [ -n "$sysconfig_tarantool" ]; then CONF_DIR=`echo "dofile('$sysconfig_tarantool') print(instance_dir)" | tarantool` fi -if [ -z "$sysconfig_tarantool" || "$CONF_DIR" = "nil" ]; then +if [ -z "$sysconfig_tarantool" -o "$CONF_DIR" = "nil" ]; then CONF_DIR="/etc/tarantool/instances.enabled" fi