среда, 25 февраля 2009 г.

bzr help: встроенная справочная служба класса "люкс" (Часть 1)

Любому пользователю bzr (от новичка до профи) время от времени нужна справочная информация: всего не упомнишь, всех нюансов в голове не удержишь, тем более если речь идет о мало используемых или незнакомых командах и опциях. В таких ситуациях нужно помнить главное: справка у вас всегда под руками. И я говорю не про man bzr, а про встроенный механизм справки, вызываемый по команде bzr help. Команда bzr help, помимо очевидных вещей типа справки к командам и опциям, имеет также неплохой каталог дополнительной справочной информации о базовых концепциях, настройках и конфигурации bzr, и даже такой материал как объяснение типов конфликтов объединения и как с ними бороться. Должен сказать, что разработчики bzr уделяют справке внимание, что положительно сказывается на ее количестве и качестве. Многие пункты справки содержат информации на несколько экранов, так что для удобства чтения используйте программы типа more или less.
Полезный совет для пользователей Windows: скачайте и установите программу less, которая значительно превосходит по функциональности стандартную more. После установки добавьте папку с программой в список в переменную окружения PATH.
Итак, посмотрим, что же может предложить bzr help. Запускаем и видим краткую сводку по базовым командам:
C:\>bzr help
Bazaar -- a free distributed version-control tool
http://bazaar-vcs.org/

Basic commands:
bzr init           makes this directory a versioned branch
bzr branch         make a copy of another branch

bzr add            make files or directories versioned
bzr ignore         ignore a file or pattern
bzr mv             move or rename a versioned file

bzr status         summarize changes in working copy
bzr diff           show detailed diffs

bzr merge          pull in changes from another branch
bzr commit         save some or all changes
bzr send           send changes via email

bzr log            show history of changes
bzr check          validate storage

bzr help init      more help on e.g. init command
bzr help commands  list all commands
bzr help topics    list all help topics
Команды сгруппированы по назначению:
  • init, branch — создание новой ветки с нуля или путем клонирования существующей
  • add, ignore, mv — процесс добавления файлов под контроль версий, информирование об игнорируемых объектах, переименование через bzr
  • status, diff — просмотр изменений в файлах
  • merge, commit, send — фиксация изменений (commit), объединений изменений в двух ветках (merge), отправка патчей по электронной почте (send)
  • log — просмотр истории изменений
Ниже вы видите пример того, как получить справку по конкретной команде — например, вызывая bzr help init либо используя опцию -h или --help после имени команды: bzr init -h. Для того, чтобы получить список всех доступных команд, запустите bzr help commands; рекомендую использовать less для просмотра:
bzr help commands | less
Будет выведен список всех команд в алфавитном порядке с кратким описанием для каждой команды. Обратите внимание на команду bzr help topics.
Эта команда выводит оглавление всех доступных материалов встроенной справки в виде списка: слева названия статей, справа — краткое описание материала. Ниже приведены первые несколько строк из списка статей (для bzr 1.12):
C:\>bzr help topics
authentication       Information on configuring authentication
basic                Basic commands
branches             Information on what a branch is
bugs                 Bug tracker settings
checkouts            Information on what a checkout is
commands             Basic help for all commands
configuration        Details on the configuration settings available
conflicts            Types of conflicts and what to do about them
Используйте название статьи для доступа к ее тексту. Например, команда
bzr help configuration
выведет справку по имеющимся настройкам для bzr. Во второй части мы рассмотрим подробнее назначение дополнительных полей справочной информации.

Комментариев нет:

Отправить комментарий