From 98afe5dc1dc3a8f0732d48de8444ffb19ca0c993 Mon Sep 17 00:00:00 2001
From: GladilovDmitry <49302260+GladilovDmitry@users.noreply.github.com>
Date: Thu, 26 Aug 2021 11:09:14 +0300
Subject: [PATCH] =?UTF-8?q?=D0=A1=D1=82=D0=B8=D0=BB=D0=B8=D1=81=D1=82?=
=?UTF-8?q?=D0=B8=D1=87=D0=B5=D1=81=D0=BA=D0=B8=D0=B5=20=D0=BF=D1=80=D0=B0?=
=?UTF-8?q?=D0=B2=D0=BA=D0=B8=20=D0=BE=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=D0=B8?=
=?UTF-8?q?=D1=8F=20=D0=BA=D0=BE=D0=BC=D0=B0=D0=BD=D0=B4=D1=8B=20sync?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
readme.md | 45 +++++++++++++++++++++------------------------
1 file changed, 21 insertions(+), 24 deletions(-)
diff --git a/readme.md b/readme.md
index 1ff0f81..c055ed7 100644
--- a/readme.md
+++ b/readme.md
@@ -288,13 +288,13 @@
#### Примеры использования
-* Простое использование
+* Примитивный вариант
`gitsync sync C:/Хранилище_1С/ C:/GIT/src`
- Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/GIT/src`
+ Команда выполнит выгрузку версий хранилища 1С из `C:/Хранилище_1С/` в репозиторий git в каталоге `C:/GIT/src`. Пример учебный, на практике обычно требуется указать также имя пользователя хранилища и пароль.
-* Инициализация в текущем рабочем каталоге,
+* Вариант вызова команды в текущем рабочем каталоге
> переменная окружения **`GITSYNC_WORKDIR`** не должна быть задана
@@ -302,33 +302,32 @@
cd C:/work_dir/
gitsync sync C:/Хранилище_1С/
```
- Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/work_dir`
+ Команда выполнит выгрузку версий хранилища 1С из `C:/Хранилище_1С/` в репозиторий git в каталоге `C:/work_dir`
-* Инициализация в с указанием пользователя и пароля.
+* Вариант с указанием пользователя хранилища и пароля
```sh
- gitsync sync --storage-user Admin --storage-pwd=Secret C:/Хранилище_1С/ C:/work_dir/
+ gitsync sync --storage-user Admin --storage-pwd Secret C:/Хранилище_1С/ C:/work_dir/
```
- Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/work_dir`
- Используя для подключения к хранилищу 1С пользователя `Admin` и пароль `Secret`
-
+ Имя пользователя = Admin, пароль = Secret.
+
* Использование синонимов (короткая версия предыдущего примера)
```sh
- gitsync s -uAdmin -p=Secret C:/Хранилище_1С/ C:/work_dir/
+ gitsync s -u Admin -p Secret C:/Хранилище_1С/ C:/work_dir/
+ # возможны варианты
+ # gitsync s -uAdmin -pSecret C:/Хранилище_1С/ C:/work_dir/
+ # gitsync s -u=Admin -p=Secret C:/Хранилище_1С/ C:/work_dir/
```
- Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/work_dir`
- Используя для подключения к хранилищу 1С пользователя `Admin` и пароль `Secret`
-* Использование конкретной исполняемого файла платформы
+* Указание исполняемого файла нужной версии платформы
```sh
gitsync --v8-path /opt/1C/v8.3/x86_64/1cv8 s -uAdmin -p=Secret C:/Хранилище_1С/ C:/work_dir/
```
- Данная команда синхронизации выполнится с использованием исполняемого файла платформы `/opt/1C/v8.3/x86_64/1cv8` для хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/work_dir`
- Используя для подключения к хранилищу 1С пользователя `Admin` и пароль `Secret`
+ Команда синхронизации будет выполнена с использованием исполняемого файла платформы `/opt/1C/v8.3/x86_64/1cv8` (приведен синтаксис для linux; вариант для Windows см. ниже).
-* Использование только переменных окружения
+* Вызов команды без указания параметров, с использованием переменных окружения
linux:
```sh
@@ -338,8 +337,8 @@
export GITSYNC_STORAGE_USER=Admin
export GITSYNC_STORAGE_PASSWORD=Secret
export GITSYNC_V8VERSION=8.3.7
- # Указание конкретного исполняемого файла платформы 1С
- #export GITSYNC_V8_PATH=/opt/1C/v8.3/x86_64/1cv8 # Надо обернуть в кавычки если путь содержит пробелы
+ # Указание конкретного исполняемого файла платформы 1С. Путь надо обернуть в кавычки если он содержит пробелы.
+ #export GITSYNC_V8_PATH=/opt/1C/v8.3/x86_64/1cv8
export GITSYNC_VERBOSE=true #Можно использовать Да/Ложь/Нет/Истина
export GITSYNC_TEMP=./temp/sync
gitsync s
@@ -352,15 +351,13 @@
set GITSYNC_STORAGE_USER=Admin
set GITSYNC_STORAGE_PASSWORD=Secret
set GITSYNC_V8VERSION=8.3.7
- # Указание конкретного исполняемого файла платформы 1С
- #set GITSYNC_V8_PATH="C:\Program Files (x86)\1cv8\8.3.12.1567\bin\1cv8.exe" # Надо обернуть в кавычки если путь содержит пробелы
+ # Указание конкретного исполняемого файла платформы 1С. Путь надо обернуть в кавычки если он содержит пробелы.
+ #set GITSYNC_V8_PATH="C:\Program Files (x86)\1cv8\8.3.12.1567\bin\1cv8.exe"
set GITSYNC_VERBOSE=true #Можно использовать Да/Ложь/Нет/Истина
set GITSYNC_TEMP=./temp/sync
gitsync s
```
- Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/work_dir`
- Используя для подключения к хранилищу 1С пользователя `Admin` и пароль `Secret`
## Использование библиотеки `gitsync`
@@ -394,13 +391,13 @@
`opm build .`
- При данной сборке не собираются предустановленные пакеты. Их надо будет устанавливать отдельно
+ В этом варианте в сборку не добавляются предустановленные пакеты. Их надо будет устанавливать отдельно.
2. Сборка пакета с зависимостями
`opm build -mf ./build_packagedef .`
- При данной сборке будут дополнительно собраны из репозиториев:
+ В сборку будут добавлены пакеты из репозиториев:
* `opm` - из ветки develop
* `gitsync-pre-plugins` - из ветки develop