Merge pull request #322 from ShootNICK-tm/feature/docs2

Добавлено описание опции команды syns для расширений
oscript-library · Sep 5, 2024 · ef8f3a8 · ef8f3a8
2 parents fbf30d7 + 45d7c91
commit ef8f3a8
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 9 deletions.
diff --git a/docs/sync.md b/docs/sync.md
@@ -18,6 +18,7 @@ sync (синоним s) - Выполняет синхронизацию хран
 Опции:
   -u, --storage-user    пользователь хранилища конфигурации (env $GITSYNC_STORAGE_USER) (по умолчанию Администратор)
   -p, --storage-pwd     пароль пользователя хранилища конфигурации (env $GITSYNC_STORAGE_PASSWORD, $GITSYNC_STORAGE_PWD)
+  -e, --ext             имя расширения для работы с хранилищем расширения(env $GITSYNC_EXTENSION)
 
 ```
 ### Глобальные переменные окружения
@@ -36,6 +37,7 @@ sync (синоним s) - Выполняет синхронизацию хран
 | `GITSYNC_STORAGE_PATH`     | путь к хранилищу конфигурации 1С.          |
 | `GITSYNC_STORAGE_USER`     | пользователь хранилища конфигурации        |
 | `GITSYNC_STORAGE_PASSWORD` | пароль пользователя хранилища конфигурации |
+| `GITSYNC_EXTENSION`        | имя расширения                             |
 
 ### Значения по умолчанию
 
@@ -52,6 +54,12 @@ sync (синоним s) - Выполняет синхронизацию хран
 
     Данная команда выполнить синхронизацию хранилища 1С по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/GIT/src`
 
+* Простое использование для выгрузки расширения конфигурации
+
+    `gitsync sync --ext ИМЯ_Расширения C:/Хранилище_1С/ C:/GIT/src`
+
+    Данная команда выполняет синхронизацию хранилища расширения 1С с именем `ИМЯ_Расширения` по пути `C:/Хранилище_1С/` и репозитория git в каталоге `C:/GIT/src`
+
 * Инициализация в текущем рабочем каталоге,
 
     > переменная окружения **`GITSYNC_WORKDIR`** не должна быть задана

diff --git a/readme.md b/readme.md
@@ -209,34 +209,35 @@
 Опции:
   -u, --storage-user    пользователь хранилища конфигурации (env $GITSYNC_STORAGE_USER) (по умолчанию Администратор)
   -p, --storage-pwd     пароль пользователя хранилища конфигурации (env $GITSYNC_STORAGE_PASSWORD, $GITSYNC_STORAGE_PWD)
-
+  -e, --ext             имя расширения для работы с хранилищем расширения(env $GITSYNC_EXTENSION)
 ```
 
 <a id="markdown-глобальные-переменные-окружения" name="глобальные-переменные-окружения"></a>
 #### Глобальные переменные окружения
-| Имя                 | Описание                                               |
-|---------------------|--------------------------------------------------------|
-| `GITSYNC_V8VERSION` | маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.) |
+| Имя                 | Описание                                                                    |
+| ------------------- | --------------------------------------------------------------------------- |
+| `GITSYNC_V8VERSION` | маска версии платформы (8.3, 8.3.5, 8.3.6.2299 и т.п.)                      |
 | `GITSYNC_V8_PATH`   | путь к исполняемому файлу платформы 1С (Например, /opt/1C/v8.3/x86_64/1cv8) |
-| `GITSYNC_VERBOSE`   | вывод отладочной информации в процессе выполнения      |
-| `GITSYNC_TEMP`      | путь к каталогу временных файлов                       |
-| `GITSYNC_EMAIL`     | домен почты для пользователей git                      |
+| `GITSYNC_VERBOSE`   | вывод отладочной информации в процессе выполнения                           |
+| `GITSYNC_TEMP`      | путь к каталогу временных файлов                                            |
+| `GITSYNC_EMAIL`     | домен почты для пользователей git                                           |
 
 <a id="markdown-переменные-окружения-команды" name="переменные-окружения-команды"></a>
 #### Переменные окружения команды
 
 | Имя                        | Описание                                   |
-|----------------------------|--------------------------------------------|
+| -------------------------- | ------------------------------------------ |
 | `GITSYNC_WORKDIR`          | рабочий каталог для команды                |
 | `GITSYNC_STORAGE_PATH`     | путь к хранилищу конфигурации 1С.          |
 | `GITSYNC_STORAGE_USER`     | пользователь хранилища конфигурации        |
 | `GITSYNC_STORAGE_PASSWORD` | пароль пользователя хранилища конфигурации |
+| `GITSYNC_EXTENSION`        | имя расширения                             |
 
 <a id="markdown-значения-по-умолчанию" name="значения-по-умолчанию"></a>
 #### Значения по умолчанию
 
 |                    |                              |
-|--------------------|------------------------------|
+| ------------------ | ---------------------------- |
 | WORKDIR            | текущая рабочая директория   |
 | -u, --storage-user | пользователь `Администратор` |
 
@@ -249,6 +250,12 @@
 
     Команда выполнит выгрузку версий хранилища 1С из `C:/Хранилище_1С/` в репозиторий git в каталоге `C:/GIT/src`. Пример учебный, на практике обычно требуется указать также имя пользователя хранилища и пароль.
 
+* Вариант для расширения конфигурации
+
+    `gitsync sync --ext ИМЯ_Расширения C:/Хранилище_1С/ C:/GIT/src`
+
+    Команда выполнит выгрузку версий хранилища расширения 1С из `C:/Хранилище_1С/` для расширения `ИМЯ_Расширения` в репозиторий git в каталоге `C:/GIT/src`. 
+
 * Вариант вызова команды в текущем рабочем каталоге
 
     > переменная окружения **`GITSYNC_WORKDIR`** не должна быть задана