Skip to content

Commit

Permalink
Merge pull request termie#50 from stefanor/manpage
Browse files Browse the repository at this point in the history
Add a simple manpage, built from rst with docutils
  • Loading branch information
alexreg committed Sep 4, 2013
2 parents 0cfcae6 + 7bf10f8 commit a02d43b
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
vendor/*
doc/*.[0-9]
12 changes: 12 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
SOURCES=$(wildcard *.[0-9].rst)
OUTPUT=$(patsubst %.rst, %, $(SOURCES))

.PHONY: all
all: $(OUTPUT)

.PHONY: clean
clean:
rm -f $(OUTPUT)

%: %.rst
rst2man $^ > $@
104 changes: 104 additions & 0 deletions doc/git-bzr.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
=========
git-bzr
=========

----------------------------------------
Bidirectional bridge between git and bzr
----------------------------------------

:Date: 2012-12-07
:Manual section: 1
:Manual group: Git-Bzr-Ng

SYNOPSIS
========

| `git bzr init`
| `git bzr clone` [--strip_tags] <url> [<target>]
| `git bzr clear` [<bzr_branch>]
| `git bzr push` [--overwrite] [--parent_branch=<parent_branch>] [<url>]
| `git bzr sync` [--overwrite] <bzr_branch>
| `git bzr pull` [--overwrite] <bzr_branch>
| `git bzr import` [--strip_tags] <url> <new_branch>
| `git bzr marks` [--file] [--git|--bzr]
DESCRIPTION
===========

A bidirectional bridge between git and bzr that lets you stop worrying
which version control the code you love is using -- as long as they are
using git or bzr.

COMMANDS
========

Several subcommands are available.
With no arguments specified, shows the available subcommands.

`init`
------

Initialize a new bzr tracking branch based on master.

`clone`
-------

Clone a bzr branch from <url> into the `master` branch of a newly
created git repository in <target>.
If the <target> isn't specified, it's deduced from the <url>.
Like `git clone`, it creates remote-tracking bzr branches.

With ``--strip_tags``, tags are stripped from bzr when importing.

`clear`
-------

Remove bzr tracking branches for <bzr_branch>, or the current branch, if
not specified.

`push`
------

Push to the bzr repository <url> (or the remembered url, if not
specified).

With ``--parent_branch=<parent_branch>``, <parent_branch> is used as the
parent branch.

With ``--overwrite``, history can be overwritten.

`sync`
------

Sync bzr tracking branch <bzr_branch>.

With ``--overwrite``, history can be overwritten.

`pull`
------

Sync bzr tracking branch <bzr_branch> and pull from it.

With ``--overwrite``, history can be overwritten.

`import`
--------

Import bzr branch <url> into a git repository, as <new_branch>.

With ``--strip_tags``, tags are stripped from bzr when importing.

`marks`
-------

Display the current marks files for the current branch.
By default, the git marks are shown, with ``--bzr``, the bzr marks are
shown.

With ``--file``, the marks file name is shown, rather than its contents.

SEE ALSO
========

``git``\ (1),
``bzr``\ (1)

0 comments on commit a02d43b

Please sign in to comment.