воскресенье, 1 марта 2009 г.

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

Рассмотрим вывод справочной информации на примере команды branch, и посмотрим какую информацию мы там можем найти.
C:\>bzr help branch
Purpose: Create a new copy of a branch.
Usage:   bzr branch FROM_LOCATION [TO_LOCATION]

Options:
  --stacked             Create a stacked branch referring to the source
                        branch. The new branch will depend on the availability
                        of the source branch for all operations.
  -v, --verbose         Display more information.
  --standalone          Do not use a shared repository, even if available.
  -h, --help            Show help message.
  -q, --quiet           Only display errors and warnings.
  --hardlink            Hard-link working tree files where possible.
  -r ARG, --revision=ARG
                        See "help revisionspec" for details.

Description:
  If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
  be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
  If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
  is derived from the FROM_LOCATION by stripping a leading scheme or drive
  identifier, if any. For example, "branch lp:foo-bar" will attempt to
  create ./foo-bar.

  To retrieve the branch as of a particular revision, supply the --revision
  parameter, as in "branch foo/bar -r 5".

Aliases:  get, clone
See also: checkout
Здесь:
  • Purpose — назначение команды
  • Usage — командная строка с указанием ожидаемых аргументов
  • Options — опции командной строки
  • Description — подробное описание команды и вариантов использования
  • Aliases — встроенные псевдонимы для команды
  • See also — ссылки на схожие по тематике разделы справки
Аргументы командной строки

Необязательные аргументы отобажаются в квадратных скобках. Если ожидается один или больше аргументов, то вы увидите многоточие после имени аргумента.

Опции командной строки

Опции могут использоваться вперемешку с аргументами, стоять до или после них. Очень удобно.

Опции -v и -q отображаются для всех команд, однако для некоторых команд они не имеют эффекта.

Псевдонимы

Некоторые команды могут иметь псевдонимы. Это сделано для удобства и для имитации поведения других систем контроля версий, чтобы пользователям при переходе на Базар было легче осваиваться. Во многих случаях псевдонимы предлагают более короткую форму записи имени для часто используемых команд. Так например, команда status имеет псевдоним st, а команда diff имеет псевдоним di.

В дополнение к встроенным псевдонимам Базар поддерживает также псевдонимы определяемые пользователем. О них мы расскажем в следующих статьях.

See also (см. также)

Многие справочные разделы (не только справка к командам) дают подсказку и наводку на материалы, схожие по тематике либо отражающие другой вариант использования. Часто так можно найти ценные советы и подсказки.

Итак, теперь вы знаете об использовании справки достаточно, чтобы не растеряться в ответственный момент. Помните, что аргументы и опции можно записывать вперемешку, и что опция -h (--help) выводит справку по команде без запуска самой команды. Так что если вы начали писать команду и вдруг решили перечитать справку по ней, то можете просто дописать -h в конце и нажать Enter. А прочитав справку, вызовите предыдущую команду (в большинстве командных процессоров это делается просто нажатием стрелки вверх) и отредактируйте ее нужным образом.

Также не забывайте, что справка ко многим командам довольно обширна, поэтому помните про использование программ типа more или less.

3 комментария:

  1. С удовольствием подписался на ваш курс про bzr. Глядишь, сам того особо не желая, буду иметь неплохое представление об одной современной SCM. Желаю дальнешего терпения для продолжений, которых, видимо, должно быть много.

    ОтветитьУдалить
  2. Этот комментарий был удален автором.

    ОтветитьУдалить
  3. Спасибо на добром слове. Да, задуман большой цикл коротких статей. Большой цикл: потому что рассказывать о разных нюансах можно много. Коротких статей: потому что так легче заставить себя писать регулярно, много времени не отнимает.

    ОтветитьУдалить