Skip to content

Commit 35e7d1c

Browse files
committed
feat docs: update changelog for 2.12 release
Tests: протестировано CI commit_hash:e43969f5d2db4e20afee259d74a0aa9f2a6c5cfc
1 parent b461df6 commit 35e7d1c

16 files changed

Lines changed: 84 additions & 60 deletions

File tree

.mapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -641,6 +641,7 @@
641641
"core/functional_tests/cache_update/config_vars.yaml":"taxi/uservices/userver/core/functional_tests/cache_update/config_vars.yaml",
642642
"core/functional_tests/cache_update/service.cpp":"taxi/uservices/userver/core/functional_tests/cache_update/service.cpp",
643643
"core/functional_tests/cache_update/static_config.yaml":"taxi/uservices/userver/core/functional_tests/cache_update/static_config.yaml",
644+
"core/functional_tests/cache_update/tests/CMakeLists.txt":"taxi/uservices/userver/core/functional_tests/cache_update/tests/CMakeLists.txt",
644645
"core/functional_tests/cache_update/tests/conftest.py":"taxi/uservices/userver/core/functional_tests/cache_update/tests/conftest.py",
645646
"core/functional_tests/cache_update/tests/test_cache_alerts.py":"taxi/uservices/userver/core/functional_tests/cache_update/tests/test_cache_alerts.py",
646647
"core/functional_tests/cache_update/tests/test_cache_update.py":"taxi/uservices/userver/core/functional_tests/cache_update/tests/test_cache_update.py",

clickhouse/include/userver/storages/clickhouse/cluster.hpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,17 @@ class Cluster final {
5353

5454
/// @brief Execute a statement at some host of the cluster
5555
/// with args as query parameters.
56+
///
57+
/// It is convinient to keep SQL queries in separate files, see @ref scripts/docs/en/userver/sql_files.md
58+
/// for more info.
5659
template <typename... Args>
5760
ExecutionResult Execute(const Query& query, const Args&... args) const;
5861

5962
/// @brief Execute a statement with specified command control settings
6063
/// at some host of the cluster with args as query parameters.
64+
///
65+
/// It is convinient to keep SQL queries in separate files, see @ref scripts/docs/en/userver/sql_files.md
66+
/// for more info.
6167
template <typename... Args>
6268
ExecutionResult Execute(OptionalCommandControl, const Query& query, const Args&... args) const;
6369

core/functional_tests/cache_update/CMakeLists.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ project(userver-core-tests-cache-update CXX)
33
add_executable(${PROJECT_NAME} "service.cpp")
44
target_link_libraries(${PROJECT_NAME} userver::core)
55

6-
userver_chaos_testsuite_add()
6+
# Test that `userver_testsuite_add` works from sub directories.
7+
add_subdirectory(tests)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
userver_testsuite_add(
2+
SERVICE_TARGET userver-core-tests-cache-update
3+
PYTEST_ARGS
4+
--service-config=${CMAKE_CURRENT_SOURCE_DIR}/../static_config.yaml
5+
--service-binary=${CMAKE_CURRENT_BINARY_DIR}/../userver-core-tests-cache-update
6+
--service-config-vars=${CMAKE_CURRENT_SOURCE_DIR}/../config_vars.yaml
7+
)

samples/static_service/testsuite/conftest.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# [Static service sample - config hook]
21
import pathlib
32

43
import pytest
@@ -18,4 +17,3 @@ def _patch_config(config_yaml, config_vars):
1817
)
1918

2019
return _patch_config
21-
# [Static service sample - config hook]

samples/static_service/testsuite/test_static.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /// Functional test
1+
# [Functional test]
22
import pytest
33

44

@@ -10,7 +10,7 @@ async def test_file(service_client, service_source_dir, path):
1010
assert response.headers['Expires'] == '600'
1111
file = service_source_dir.joinpath('public') / 'index.html'
1212
assert response.content.decode() == file.open().read()
13-
# /// Functional test
13+
# [Functional test]
1414

1515

1616
async def test_file_not_found(service_client):

scripts/docs/customdoxygen.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,14 +232,14 @@ span.paramname em {
232232

233233

234234
/* Scale down image to the page width */
235-
.image img {
235+
.image img, p > img {
236236
max-width: calc(100% - 7px - 7px - 1px - 1px);
237237
background-color: var(--primary-color-1);
238-
/* matches .fragment */
239238
border: 1px solid var(--separator-color);
240239
/* matches .fragment */
241240
padding: 7px;
242241
/* matches .fragment */
242+
border-radius: var(--border-radius-large);
243243
}
244244

245245
hr {
@@ -1221,4 +1221,4 @@ pre {
12211221

12221222
#nav-sync {
12231223
display: none;
1224-
}
1224+
}

scripts/docs/doxygen.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
376376
#
377377
# Note see also the list of default file extension mappings.
378378

379-
EXTENSION_MAPPING = json=Javascript
379+
EXTENSION_MAPPING = json=Javascript js=Javascript
380380

381381
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
382382
# according to the Markdown format, which allows for more readable

scripts/docs/en/userver/functional_testing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Supported features:
2323

2424
## CMake integration
2525

26-
### CMake integration via `userver_testsuite_add()`
26+
### CMake integration via userver_testsuite_add()
2727

2828
With `userver_testsuite_add()` function you can easily add testsuite support to your project.
2929
Its main purpose is:
@@ -37,7 +37,7 @@ Its main purpose is:
3737
Then create testsuite target:
3838
@snippet samples/testsuite-support/CMakeLists.txt testsuite - cmake
3939

40-
### `userver_testsuite_add()` arguments
40+
### userver_testsuite_add() arguments
4141

4242
* SERVICE_TARGET, required CMake name of the target service to test. Used as
4343
suffix for `testsuite-` and `start-` CMake target names.
@@ -66,7 +66,7 @@ Some of the most useful arguments for PYTEST_ARGS:
6666
| `--service-wait` | With this argument the testsuite will wait for the service start by user. For example under gdb. Testsuite outputs a hint on starting the service |
6767
| `-rf` | Show a summary of failed tests |
6868

69-
### CMake integration via `userver_testsuite_add_simple()`
69+
### CMake integration via userver_testsuite_add_simple()
7070

7171
`userver_testsuite_add_simple()` is a version of `userver_testsuite_add()`
7272
that makes some assumptions of the project structure.
@@ -500,7 +500,7 @@ def test_service(service_client):
500500

501501
Testsuite allows to create tests that start a new service instance for the test and stop it on test finish:
502502

503-
@snippet samples/testsuite-support/tests/test_metrics.py uservice_oneshot sample
503+
@snippet samples/testsuite-support/tests/test_metrics.py uservice_oneshot sample
504504

505505
Such functionality slows down the tests run, but it may be required
506506
* to test service state right after the service start,

scripts/docs/en/userver/gdb_debugging.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ See [GDB manual](https://www.sourceware.org/gdb/current/onlinedocs/gdb.html/Auto
2424

2525
### Custom pretty-printers
2626

27-
The simplest extentions for GDB, that userver provides, are pretty-printers for certain data stuctures. Below is an
27+
The simplest extensions for GDB, that userver provides, are pretty-printers for certain data structures. Below is an
2828
example comparing the output for a `formats::json::Value` with and without pretty-printers:
2929

3030
```
@@ -34,11 +34,11 @@ $1 = {["a"] = {1, 2, 3, 4}, ["c"] = 123, ["d"] = false, ["e"] = "", ["f"] = {["k
3434
181 printers disabled
3535
0 of 181 printers enabled
3636
(gdb) print value
37-
$2 = {holder_ = {static kInvalidVersion = 18446744073709551615, data_ = {__ptr_ = 0x10f27fe04118, __cntrl_ = 0x10f27fe04100}},
38-
root_ptr_for_path_ = 0x10f27fe04118, value_ptr_ = 0x10f27fe04118, depth_ = 0, lazy_detached_path_ = {parent_value_ptr_ = 0x0,
39-
parent_depth_ = 0, virtual_path_ = {static __endian_factor = 2, __rep_ = {__s = {{__is_long_ = 0 '\000', __size_ = 0 '\000'},
40-
__padding_ = {<No data fields>}, __data_ = '\000' <repeats 22 times>}, __l = {{__is_long_ = 0, __cap_ = 0}, __size_ = 0,
41-
__data_ = 0x0}}, __padding1_933_ = {__padding_ = 0x7fffffffd7c0 ""},
37+
$2 = {holder_ = {static kInvalidVersion = 18446744073709551615, data_ = {__ptr_ = 0x10f27fe04118, __cntrl_ = 0x10f27fe04100}},
38+
root_ptr_for_path_ = 0x10f27fe04118, value_ptr_ = 0x10f27fe04118, depth_ = 0, lazy_detached_path_ = {parent_value_ptr_ = 0x0,
39+
parent_depth_ = 0, virtual_path_ = {static __endian_factor = 2, __rep_ = {__s = {{__is_long_ = 0 '\000', __size_ = 0 '\000'},
40+
__padding_ = {<No data fields>}, __data_ = '\000' <repeats 22 times>}, __l = {{__is_long_ = 0, __cap_ = 0}, __size_ = 0,
41+
__data_ = 0x0}}, __padding1_933_ = {__padding_ = 0x7fffffffd7c0 ""},
4242
__alloc_ = {<std::__y1::__non_trivial_if<true, std::__y1::allocator<char> >> = {<No data fields>}, <No data fields>}, __padding2_933_ = {
4343
__padding_ = 0x7fffffffd7c0 ""}, static npos = 18446744073709551615}}}
4444
```
@@ -56,7 +56,7 @@ In addition, the output has a hierarchical structure that is displayed correctly
5656

5757
* `utask list`: Lists all tasks with their names (corresponding span names) and statuses. Example:
5858
```
59-
(gdb) utask list
59+
(gdb) utask list
6060
Task State Span
6161
0x10f27fc40800 Suspended task_3
6262
0x10f27fc3f000 Suspended task_2
@@ -66,13 +66,13 @@ Task State Span
6666
0x10f27fc42000 Running task_4
6767
```
6868

69-
* `utask apply <task> <cmd...>`: Executes `<cmd...>` in the context of selected `<task>`. The `<task>` may be
69+
* `utask apply <task> <cmd...>`: Executes `<cmd...>` in the context of selected `<task>`. The `<task>` may be
7070
specified by its ID ("Task") or name ("Span") (as shown in `utask list`), or set to "all" to apply the command to all
7171
tasks. `<cmd...>` can be any GDB command, including Python scripts.
7272

7373

7474
#### Examples:
75-
75+
7676
1. Print "Hello world!" for all tasks
7777
```
7878
(gdb) utask apply all print "Hello world!"
@@ -121,9 +121,9 @@ For now `utask` commands are implemented for only linux x86 platforms, but can b
121121
In addition, all of the above functionality works for debugging both a live process and coredumps.
122122

123123

124-
## GDB complains: received signal ?, Unknown signal
124+
## GDB complains: received signal ?, Unknown signal
125125

126-
This is a side effect of stack usage monitor interferring with GDB. In unit tests you can set the environment variable
126+
This is a side effect of stack usage monitor interfering with GDB. In unit tests you can set the environment variable
127127
`USERVER_GTEST_ENABLE_STACK_USAGE_MONITOR=0` to disable the monitor, in other binaries you can either disable it
128128
via static config option `coro_pool.stack_usage_monitor_enabled` in components::ManagerControllerComponent or by
129129
disabling it at all at build time of the framework via `USERVER_FEATURE_STACK_USAGE_MONITOR`

0 commit comments

Comments
 (0)