Skip to content

Commit b922c16

Browse files
halfdarkangelapolukhin
authored andcommitted
feat docs: update gentoo build docs
Tests: на прод не влияет --- Pull Request resolved: #1142 Co-authored-by: antoshkka <antoshkka@userver.tech> Co-authored-by: antoshkka <antoshkka@userver.tech> commit_hash:6ad19ebb704378c4e4614cd9611b0ce2cee730cb
1 parent b54c0c7 commit b922c16

File tree

6 files changed

+71
-41
lines changed

6 files changed

+71
-41
lines changed

.mapping.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4513,7 +4513,6 @@
45134513
"scripts/docs/en/deps/debian-12.md":"taxi/uservices/userver/scripts/docs/en/deps/debian-12.md",
45144514
"scripts/docs/en/deps/debian-13.md":"taxi/uservices/userver/scripts/docs/en/deps/debian-13.md",
45154515
"scripts/docs/en/deps/fedora-42.md":"taxi/uservices/userver/scripts/docs/en/deps/fedora-42.md",
4516-
"scripts/docs/en/deps/gentoo.md":"taxi/uservices/userver/scripts/docs/en/deps/gentoo.md",
45174516
"scripts/docs/en/deps/macos.md":"taxi/uservices/userver/scripts/docs/en/deps/macos.md",
45184517
"scripts/docs/en/deps/ubuntu-22.04.md":"taxi/uservices/userver/scripts/docs/en/deps/ubuntu-22.04.md",
45194518
"scripts/docs/en/deps/ubuntu-22.04/chaotic":"taxi/uservices/userver/scripts/docs/en/deps/ubuntu-22.04/chaotic",

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
[![Build and publish ubuntu-24.04-userver images](https://github.com/userver-framework/userver/actions/workflows/publish-ubuntu-24.04-images.yaml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/publish-ubuntu-24.04-images.yaml)
1414
[![Build and publish ubuntu-22.04-userver images](https://github.com/userver-framework/userver/actions/workflows/publish-ubuntu-22.04-images.yaml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/publish-ubuntu-22.04-images.yaml)
15+
[![Gentoo Systemd with Overlay CI](https://github.com/userver-framework/userver-overlay/actions/workflows/gentoo.yml/badge.svg)](https://github.com/userver-framework/userver-overlay/actions/workflows/gentoo.yml)
1516

1617
[![uservice-dynconf CI](https://github.com/userver-framework/uservice-dynconf/actions/workflows/ci.yml/badge.svg)](https://github.com/userver-framework/uservice-dynconf/actions/workflows/ci.yml)
1718
[![uservice-dynconf Docker build](https://github.com/userver-framework/uservice-dynconf/actions/workflows/docker.yaml/badge.svg?branch=develop)](https://github.com/userver-framework/uservice-dynconf/actions/workflows/docker.yaml)

scripts/docs/en/deps/gentoo.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

scripts/docs/en/userver/build/build.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,46 @@ target_link_libraries(${PROJECT_NAME} PUBLIC userver::grpc)
453453
454454
@see @ref userver_libraries
455455
456+
@anchor gentoo_ebuild
457+
## Gentoo ebuild
458+
459+
You can install userver via Emerge in Gentoo Linux:
460+
461+
1. Set needed use-flags in file `/etc/portage/package.use/userver`:
462+
463+
```bash
464+
dev-cpp/userver-framework flag1 flag2 ...
465+
```
466+
467+
Supported use-flags:
468+
469+
```
470+
postgres - Provide asynchronous driver for PostgreSQL
471+
redis - Provide asynchronous driver for Redis
472+
mongodb - Provide asynchronous driver for MongoDB
473+
mysql - Provide asynchronous driver for MySQL/MariaDB
474+
rabbitmq - Provide asynchronous driver for RabbitMQ (AMQP 0-9-1)
475+
kafka - Provide asynchronous driver for Apache Kafka
476+
utest - Provide utest and ubench for unit testing and benchmarking coroutines
477+
testsuite - Enable functional tests via testsuite
478+
easy - Build easy HTTP server library
479+
odbc - Provide asynchronous driver for ODBC
480+
sqlite - Provide asynchronous driver for SQLite
481+
uboost-coro - Build with vendored version of Boost.context and Boost.coroutine2
482+
```
483+
484+
2. Install userver:
485+
486+
```bash
487+
sudo emerge app-portage/eselect-repository
488+
sudo eselect repository add userver-framework git https://github.com/userver-framework/userver-overlay.git
489+
sudo emerge --sync
490+
sudo emerge --ask dev-cpp/userver
491+
```
492+
493+
494+
495+
456496
457497
## Yandex Cloud with Ubuntu 22.04
458498

scripts/docs/en/userver/build/dependencies.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,21 +88,46 @@ USERVER_FEATURE_PATCH_LIBPQ=0
8888

8989
### Gentoo
9090

91-
\b Dependencies: @ref scripts/docs/en/deps/gentoo.md "third_party/userver/scripts/docs/en/deps/gentoo.md"
91+
\b Dependencies: https://github.com/userver-framework/userver-overlay/blob/master/dev-cpp/userver-meta/userver-meta-2.13.ebuild
9292

9393
Dependencies can be installed via:
9494

9595
```bash
96-
DEPS_FILE="https://raw.githubusercontent.com/userver-framework/userver/refs/heads/develop/scripts/docs/en/deps/gentoo.md" && \
97-
sudo emerge --ask --update --oneshot $(wget -q -O - ${DEPS_FILE})
96+
sudo emerge app-portage/eselect-repository
97+
sudo eselect repository add userver-framework git https://github.com/userver-framework/userver-overlay.git
98+
sudo emerge --sync
99+
sudo emerge --ask dev-cpp/userver-meta
98100
```
99101

100102
Recommended CMake options:
101103

102104
```
103-
USERVER_CHECK_PACKAGE_VERSIONS=0
105+
USERVER_CHECK_PACKAGE_VERSIONS=OFF
106+
USERVER_FEATURE_STACKTRACE=OFF
107+
USERVER_FEATURE_GRPC=OFF
108+
USERVER_FEATURE_GRPC_REFLECTION=OFF
109+
USERVER_FEATURE_REDIS_TLS=OFF
110+
USERVER_FEATURE_CLICKHOUSE=OFF
111+
USERVER_FEATURE_ROCKS=OFF
112+
USERVER_FEATURE_OTLP=OFF
113+
USERVER_FEATURE_S3API=OFF
104114
```
105115

116+
Use-flags:
117+
118+
```
119+
grpc - install dependencies to build with Grpc (unrecomented) (use with Cmake option USERVER_FEATURE_GRPC=ON)
120+
postgres - install dependencies to build with PostgreSQL (use with Cmake option USERVER_FEATURE_POSTGRESQL=ON)
121+
redis - install dependencies to build with Redis db (use with Cmake option USERVER_FEATURE_REDIS=ON)
122+
mongodb - install dependencies to build with Mongo db (use with Cmake option USERVER_FEATURE_MONGODB=ON)
123+
mysql - install dependencies to build with MySQL (MariaDB) (use with Cmake option USERVER_FEATURE_MYSQL=ON)
124+
rabbitmq - install dependencies to build with RabbitMQ messages broker (use with Cmake option USERVER_FEATURE_RABBITMQ=ON)
125+
kafka - install dependencies to build with Apache Kafka (use with Cmake option USERVER_FEATURE_KAFKA=ON)
126+
rocksdb - install dependencies to build with RocksDB (unrecomented) (use with Cmake option USERVER_FEATURE_ROCKS=ON)
127+
utest - install dependencies to build with Utest (use with Cmake option USERVER_FEATURE_UTEST=ON)
128+
odbc - install dependencies to build with Complete ODBC driver manager (use with Cmake option USERVER_FEATURE_ODBC=ON)
129+
sqlite - install dependencies to build with sqlite (use with Cmake option USERVER_FEATURE_SQLITE=ON)
130+
```
106131

107132
### Alpine
108133

scripts/docs/en/userver/distro_maintainers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ Currently we're looking for maintainers for the following OSes/distros:
2828
* Fedora
2929
* Debian
3030
* ArchLinux
31-
* Gentoo
3231
* FreeBSD
3332
* Conan package
3433

@@ -39,6 +38,7 @@ The list is not complete, you may suggest your own distro to maintain.
3938

4039
Active maintainers so far:
4140
- Ubuntu - userver team
41+
- Gentoo - [halfdarkangel](https://t.me/halfdarkangel)
4242

4343

4444
## Contacts

0 commit comments

Comments
 (0)